AdpProviderCollection.cs :  » Persistence-Frameworks » Advanced-Data-Provider » Advanced » Data » Provider » C# / CSharp Open Source

#region Copyright
// Advanced.Data.Provider.AdpProviderCollection  
// 
// Copyright (C) 2004 Astrein Engenharia de Manuteno S/A
// Copyright (C) 2004 Everaldo Canuto <everaldo_canuto@yahoo.com.br>
// 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 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 GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#endregion

using System;
using System.Collections;
using System.Collections.Specialized;

namespace Advanced.Data.Provider{
  /// <summary>
  /// A collection that stores <see cref='AdpProvider'/> objects.
  /// </summary>
  [Serializable()]
  public class AdpProviderCollection : DictionaryBase
  {
    #region Contructors and destructors

    /// <summary>
    /// Initializes a new instance of <see cref='AdpProviderCollection'/>.
    /// </summary>
    public AdpProviderCollection() 
    {
    }

    #endregion

    #region Public properties

    /// <summary>
    /// Represents the entry at the specified index of the <see cref='AdpProvider'/>.
    /// </summary>
    public AdpProvider this[string Name] 
    {
      get 
      {
        return ((AdpProvider)(Dictionary[Name]));
      }
      set 
      {
        Dictionary[Name] = value;
      }
    }

    #endregion

    #region Public methods

    /// <summary>
    /// Adds a <see cref='AdpProvider'/> with the specified value to the <see cref='AdpProviderCollection'/>.
    /// </summary>
    /// <param name='value'>The <see cref='AdpProvider'/> to add.</param>
    public void Add(AdpProvider value) 
    {
      Dictionary.Add(value.Name, value);
    }

    /// <summary>
    /// Removes a specific <see cref='AdpProvider'/> from the <see cref='AdpProviderCollection'/>.
    /// </summary>
    /// <param name='value'>The <see cref='AdpProvider'/> to remove from the <see cref='AdpProviderCollection'/> .</param>
    public void Remove(AdpProvider value) 
    {
      Dictionary.Remove(value);
    }
    
    /// <summary>
    /// Gets a value indicating whether the <see cref='AdpProviderCollection'/> contains the specified <see cref='AdpProvider'/>.
    /// </summary>
    /// <param name='value'>The <see cref='AdpProvider'/> to locate.</param>
    /// <returns><see langword='true'/> if the <see cref='AdpProvider'/> is contained in the collection otherwise, <see langword='false'/>.</returns>
    public bool Contains(AdpProvider value) 
    {
      return Dictionary.Contains(value);
    }

    /// <summary>
    /// Gets a value indicating whether the <see cref='AdpProviderCollection'/> contains the specified <see cref='AdpProvider'/>.
    /// </summary>
    /// <param name='value'>The <see cref='AdpProvider'/> name to locate.</param>
    /// <returns><see langword='true'/> if the <see cref='AdpProvider'/> is contained in the collection otherwise, <see langword='false'/>.</returns>
    public bool Contains(string value) 
    {
      return Dictionary.Contains(value);
    }
    
    /// <summary>
    /// Returns an enumerator that can iterate through the <see cref='AdpProviderCollection'/>.
    /// </summary>
    /// <returns><see cref='AdpProviderEnumerator'/> object.</returns>
    public new AdpProviderEnumerator GetEnumerator() 
    {
      return new AdpProviderEnumerator(this);
    }

    #endregion
  }
}