#region CPL License
/*
Nuclex.NAnt.Tasks
Copyright (C) 2009 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion

using System;
using System.Collections;

using NAnt.Core.Types;

namespace Nuclex.NAnt.Tasks {

  /// <summary>
  ///   Contains a collection of <see cref="T:NAnt.Compression.Types.FileSet" /> elements.
  /// </summary>
  [Serializable]
  public class FileSetCollection : CollectionBase {

    /// <summary>
    ///   Initializes a new instance of the
    ///   <see cref="T:NAnt.Compression.Types.FileSetCollection" /> class.
    /// </summary>
    public FileSetCollection() { }

    /// <summary>
    ///   Initializes a new instance of the
    ///   <see cref="T:NAnt.Compression.Types.FileSetCollection" /> class
    ///   with the specified <see cref="T:NAnt.Compression.Types.FileSetCollection" />
    ///   instance.
    /// </summary>
    public FileSetCollection(FileSetCollection value) {
      this.AddRange(value);
    }

    /// <summary>
    ///   Initializes a new instance of the
    ///   <see cref="T:NAnt.Compression.Types.FileSetCollection" /> class
    ///   with the specified array of <see cref="T:NAnt.Compression.Types.FileSet" />
    ///   instances.
    /// </summary>
    public FileSetCollection(FileSet[] value) {
      this.AddRange(value);
    }

    /// <summary>
    ///   Adds a <see cref="T:NAnt.Compression.Types.FileSet" /> to the end of
    ///   the collection.
    /// </summary>
    /// <param name="item">
    ///   The <see cref="T:NAnt.Compression.Types.FileSet" /> to be added to the end of
    ///   the collection.
    /// </param>
    /// <returns>The position into which the new element was inserted.</returns>
    public int Add(FileSet item) {
      return base.List.Add(item);
    }

    /// <summary>
    ///   Adds the elements of a <see cref="T:NAnt.Compression.Types.FileSet" /> array to
    ///   the end of the collection.
    /// </summary>
    /// <param name="items">
    ///   The array of <see cref="T:NAnt.Compression.Types.FileSet" /> elements to be added
    ///   to the end of the collection.
    /// </param>
    public void AddRange(FileSet[] items) {
      for(int i = 0; i < items.Length; i++) {
        this.Add(items[i]);
      }
    }

    /// <summary>
    ///   Adds the elements of a <see cref="T:NAnt.Compression.Types.FileSetCollection" />
    ///   to the end of the collection.
    /// </summary>
    /// <param name="items">
    ///   The <see cref="T:NAnt.Compression.Types.FileSetCollection" /> to be added to
    ///   the end of the collection.
    /// </param>
    public void AddRange(FileSetCollection items) {
      for(int i = 0; i < items.Count; i++) {
        this.Add(items[i]);
      }
    }

    /// <summary>
    ///   Determines whether a <see cref="T:NAnt.Compression.Types.FileSet" /> is in
    ///   the collection.
    /// </summary>
    /// <param name="item">
    ///   The <see cref="T:NAnt.Compression.Types.FileSet" /> to locate in the collection.
    /// </param> 
    /// <returns>
    ///   <see langword="true" /> if <paramref name="item" /> is found in
    ///   the  collection; otherwise, <see langword="false" />.
    /// </returns>
    public bool Contains(FileSet item) {
      return base.List.Contains(item);
    }

    /// <summary>
    ///   Copies the entire collection to a compatible one-dimensional array, starting at
    ///   the specified index of the target array.
    /// </summary>
    /// <param name="array">
    ///   The one-dimensional array that is the destination of the elements copied from
    ///   the collection. The array must have zero-based indexing.
    /// </param> 
    /// <param name="index">
    ///   The zero-based index in <paramref name="array" /> at which copying begins.
    /// </param>
    public void CopyTo(FileSet[] array, int index) {
      base.List.CopyTo(array, index);
    }

    /// <summary>Returns an enumerator that can iterate through the collection.</summary>
    /// <returns>
    ///   A <see cref="T:NAnt.Compression.Types.FileSetEnumerator" /> for
    ///   the entire collection.
    /// </returns>
    public new FileSetEnumerator GetEnumerator() {
      return new FileSetEnumerator(this);
    }

    /// <summary>
    ///   Retrieves the index of a specified
    ///   <see cref="T:NAnt.Compression.Types.FileSet" /> object in the collection.
    /// </summary>
    /// <param name="item">
    ///   The <see cref="T:NAnt.Compression.Types.FileSet" /> object for which the index
    ///   is returned.
    /// </param> 
    /// <returns>
    ///   The index of the specified <see cref="T:NAnt.Compression.Types.FileSet" />.
    ///   If the <see cref="T:NAnt.Compression.Types.FileSet" /> is not currently
    ///   a member of the collection, it returns -1.
    /// </returns>
    public int IndexOf(FileSet item) {
      return base.List.IndexOf(item);
    }

    /// <summary>
    ///   Inserts a <see cref="T:NAnt.Compression.Types.FileSet" /> into the collection at
    ///   the specified index.
    /// </summary>
    /// <param name="index">
    ///   The zero-based index at which <paramref name="item" /> should be inserted.
    /// </param>
    /// <param name="item">
    ///   The <see cref="T:NAnt.Compression.Types.FileSet" /> to insert.
    /// </param>
    public void Insert(int index, FileSet item) {
      base.List.Insert(index, item);
    }

    /// <summary>Removes a member from the collection.</summary>
    /// <param name="item">
    ///   The <see cref="T:NAnt.Compression.Types.FileSet" /> to remove from the collection.
    /// </param>
    public void Remove(FileSet item) {
      base.List.Remove(item);
    }

    /// <summary>
    ///   Get the total number of files that are represented by the filesets in
    ///   this collection.
    /// </summary>
    public int FileCount {
      get {
        int fileCount = 0;
        foreach(FileSet fileset in base.List) {
          fileCount += fileset.FileNames.Count;
        }
        return fileCount;
      }
    }

    /// <summary>Gets or sets the element at the specified index.</summary>
    /// <param name="index">The zero-based index of the element to get or set.</param>
    public FileSet this[int index] {
      get {
        return (FileSet)base.List[index];
      }
      set {
        base.List[index] = value;
      }
    }
  }

} // namespace Nuclex.NAnt.Tasks