Прочитать на английском

Поделиться через


DictionaryBase Класс

Определение

Предоставляет базовый класс abstract для строго типизированной коллекции пар "ключ-значение".

public abstract class DictionaryBase : System.Collections.IDictionary
[System.Serializable]
public abstract class DictionaryBase : System.Collections.IDictionary
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class DictionaryBase : System.Collections.IDictionary
Наследование
DictionaryBase
Производный
Атрибуты
Реализации

Примеры

В следующем примере кода реализуется DictionaryBase класс и используется эта реализация для создания словаря ключей String и значений Length , которые содержат не более 5 символов.

using System;
using System.Collections;

public class ShortStringDictionary : DictionaryBase  {

   public String this[ String key ]  {
      get  {
         return( (String) Dictionary[key] );
      }
      set  {
         Dictionary[key] = value;
      }
   }

   public ICollection Keys  {
      get  {
         return( Dictionary.Keys );
      }
   }

   public ICollection Values  {
      get  {
         return( Dictionary.Values );
      }
   }

   public void Add( String key, String value )  {
      Dictionary.Add( key, value );
   }

   public bool Contains( String key )  {
      return( Dictionary.Contains( key ) );
   }

   public void Remove( String key )  {
      Dictionary.Remove( key );
   }

   protected override void OnInsert( Object key, Object value )  {
      if ( key.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "key must be of type String.", "key" );
        }
        else  {
         String strKey = (String) key;
         if ( strKey.Length > 5 )
            throw new ArgumentException( "key must be no more than 5 characters in length.", "key" );
      }

      if ( value.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "value must be of type String.", "value" );
        }
        else  {
         String strValue = (String) value;
         if ( strValue.Length > 5 )
            throw new ArgumentException( "value must be no more than 5 characters in length.", "value" );
      }
   }

   protected override void OnRemove( Object key, Object value )  {
      if ( key.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "key must be of type String.", "key" );
        }
        else  {
         String strKey = (String) key;
         if ( strKey.Length > 5 )
            throw new ArgumentException( "key must be no more than 5 characters in length.", "key" );
      }
   }

   protected override void OnSet( Object key, Object oldValue, Object newValue )  {
      if ( key.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "key must be of type String.", "key" );
        }
        else  {
         String strKey = (String) key;
         if ( strKey.Length > 5 )
            throw new ArgumentException( "key must be no more than 5 characters in length.", "key" );
      }

      if ( newValue.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "newValue must be of type String.", "newValue" );
        }
        else  {
         String strValue = (String) newValue;
         if ( strValue.Length > 5 )
            throw new ArgumentException( "newValue must be no more than 5 characters in length.", "newValue" );
      }
   }

   protected override void OnValidate( Object key, Object value )  {
      if ( key.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "key must be of type String.", "key" );
        }
        else  {
         String strKey = (String) key;
         if ( strKey.Length > 5 )
            throw new ArgumentException( "key must be no more than 5 characters in length.", "key" );
      }

      if ( value.GetType() != typeof(System.String) )
        {
            throw new ArgumentException( "value must be of type String.", "value" );
        }
        else  {
         String strValue = (String) value;
         if ( strValue.Length > 5 )
            throw new ArgumentException( "value must be no more than 5 characters in length.", "value" );
      }
   }
}

public class SamplesDictionaryBase  {

   public static void Main()  {

      // Creates and initializes a new DictionaryBase.
      ShortStringDictionary mySSC = new ShortStringDictionary();

      // Adds elements to the collection.
      mySSC.Add( "One", "a" );
      mySSC.Add( "Two", "ab" );
      mySSC.Add( "Three", "abc" );
      mySSC.Add( "Four", "abcd" );
      mySSC.Add( "Five", "abcde" );

      // Display the contents of the collection using foreach. This is the preferred method.
      Console.WriteLine( "Contents of the collection (using foreach):" );
      PrintKeysAndValues1( mySSC );

      // Display the contents of the collection using the enumerator.
      Console.WriteLine( "Contents of the collection (using enumerator):" );
      PrintKeysAndValues2( mySSC );

      // Display the contents of the collection using the Keys property and the Item property.
      Console.WriteLine( "Initial contents of the collection (using Keys and Item):" );
      PrintKeysAndValues3( mySSC );

      // Tries to add a value that is too long.
      try  {
         mySSC.Add( "Ten", "abcdefghij" );
      }
      catch ( ArgumentException e )  {
         Console.WriteLine( e.ToString() );
      }

      // Tries to add a key that is too long.
      try  {
         mySSC.Add( "Eleven", "ijk" );
      }
      catch ( ArgumentException e )  {
         Console.WriteLine( e.ToString() );
      }

      Console.WriteLine();

      // Searches the collection with Contains.
      Console.WriteLine( "Contains \"Three\": {0}", mySSC.Contains( "Three" ) );
      Console.WriteLine( "Contains \"Twelve\": {0}", mySSC.Contains( "Twelve" ) );
      Console.WriteLine();

      // Removes an element from the collection.
      mySSC.Remove( "Two" );

      // Displays the contents of the collection.
      Console.WriteLine( "After removing \"Two\":" );
      PrintKeysAndValues1( mySSC );
   }

   // Uses the foreach statement which hides the complexity of the enumerator.
   // NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
   public static void PrintKeysAndValues1( ShortStringDictionary myCol )  {
      foreach ( DictionaryEntry myDE in myCol )
         Console.WriteLine( "   {0,-5} : {1}", myDE.Key, myDE.Value );
      Console.WriteLine();
   }

   // Uses the enumerator.
   // NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
   public static void PrintKeysAndValues2( ShortStringDictionary myCol )  {
      DictionaryEntry myDE;
      System.Collections.IEnumerator myEnumerator = myCol.GetEnumerator();
      while ( myEnumerator.MoveNext() )
         if ( myEnumerator.Current != null )  {
            myDE = (DictionaryEntry) myEnumerator.Current;
            Console.WriteLine( "   {0,-5} : {1}", myDE.Key, myDE.Value );
         }
      Console.WriteLine();
   }

   // Uses the Keys property and the Item property.
   public static void PrintKeysAndValues3( ShortStringDictionary myCol )  {
      ICollection myKeys = myCol.Keys;
      foreach ( String k in myKeys )
         Console.WriteLine( "   {0,-5} : {1}", k, myCol[k] );
      Console.WriteLine();
   }
}


/*
This code produces the following output.

Contents of the collection (using foreach):
   Three : abc
   Five  : abcde
   Two   : ab
   One   : a
   Four  : abcd

Contents of the collection (using enumerator):
   Three : abc
   Five  : abcde
   Two   : ab
   One   : a
   Four  : abcd

Initial contents of the collection (using Keys and Item):
   Three : abc
   Five  : abcde
   Two   : ab
   One   : a
   Four  : abcd

System.ArgumentException: value must be no more than 5 characters in length.
Parameter name: value
   at ShortStringDictionary.OnValidate(Object key, Object value)
   at System.Collections.DictionaryBase.System.Collections.IDictionary.Add(Object key, Object value)
   at SamplesDictionaryBase.Main()
System.ArgumentException: key must be no more than 5 characters in length.
Parameter name: key
   at ShortStringDictionary.OnValidate(Object key, Object value)
   at System.Collections.DictionaryBase.System.Collections.IDictionary.Add(Object key, Object value)
   at SamplesDictionaryBase.Main()

Contains "Three": True
Contains "Twelve": False

After removing "Two":
   Three : abc
   Five  : abcde
   One   : a
   Four  : abcd

*/

Комментарии

Важно!

Мы не рекомендуем использовать класс для новой разработки DictionaryBase . Вместо этого рекомендуется использовать универсальный Dictionary<TKey,TValue> класс или KeyedCollection<TKey,TItem> . Дополнительные сведения см. в статье Неуниверсивные коллекции не должны использоваться на GitHub.

Оператор C# foreach и Оператор Visual Basic For Each возвращают объект типа элементов в коллекции. Так как каждый элемент DictionaryBase является парой "ключ-значение", тип элемента не является типом ключа или типом значения. Вместо этого тип элемента — DictionaryEntry.

Оператор foreach представляет собой оболочку для перечислителя, которая позволяет выполнять только чтение из коллекции, а не запись в нее.

Примечание

Так как ключи могут быть унаследованы и их поведение изменилось, их абсолютная уникальность не может быть гарантирована сравнениями с помощью Equals метода .

Примечания для тех, кто реализует этот метод

Этот базовый класс предоставляется, чтобы упростить для разработчиков создание строго типизированной пользовательской коллекции. Для разработчиков рекомендуется расширять этот базовый класс, а не создавать собственный.

Члены этого базового класса защищены и предназначены для использования только в производном классе.

Конструкторы

DictionaryBase()

Инициализирует новый экземпляр класса DictionaryBase.

Свойства

Count

Возвращает количество элементов, содержащихся в экземпляре DictionaryBase.

Dictionary

Получает список элементов, содержащихся в экземпляре DictionaryBase.

InnerHashtable

Получает список элементов, содержащихся в экземпляре DictionaryBase.

Методы

Clear()

Удаляет содержимое экземпляра DictionaryBase.

CopyTo(Array, Int32)

Копирует элементы класса DictionaryBase в одномерный массив класса Array с указанного индекса.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetEnumerator()

Возвращает перечислитель IDictionaryEnumerator, осуществляющий перебор элементов экземпляра класса DictionaryBase.

GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
OnClear()

Осуществляет дополнительные пользовательские действия перед удалением содержимого экземпляра класса DictionaryBase.

OnClearComplete()

Осуществляет дополнительные пользовательские действия после удаления содержимого экземпляра класса DictionaryBase.

OnGet(Object, Object)

Получает элемент с указанными ключом и значением из экземпляра класса DictionaryBase.

OnInsert(Object, Object)

Выполняет дополнительные пользовательские действия перед вставкой нового элемента в экземпляр класса DictionaryBase.

OnInsertComplete(Object, Object)

Выполняет дополнительные пользовательские действия после вставки нового элемента в экземпляр класса DictionaryBase.

OnRemove(Object, Object)

Осуществляет дополнительные пользовательские действия перед удалением элемента из экземпляра класса DictionaryBase.

OnRemoveComplete(Object, Object)

Осуществляет дополнительные пользовательские действия после удаления элемента из экземпляра класса DictionaryBase.

OnSet(Object, Object, Object)

Выполняет дополнительные пользовательские действия перед заданием значения в экземпляре класса DictionaryBase.

OnSetComplete(Object, Object, Object)

Выполняет дополнительные пользовательские действия после задания значения в экземпляре класса DictionaryBase.

OnValidate(Object, Object)

Выполняет дополнительные пользовательские операции при проверке элемента с указанными ключом и значением.

ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)

Явные реализации интерфейса

ICollection.IsSynchronized

Возвращает значение, указывающее на то, является ли доступ к объекту DictionaryBase синхронизированным (потокобезопасным).

ICollection.SyncRoot

Получает объект, который позволяет синхронизировать доступ к объекту DictionaryBase.

IDictionary.Add(Object, Object)

Добавляет элемент с указанными ключом и значением в словарь DictionaryBase.

IDictionary.Contains(Object)

Определяет, содержит ли объект DictionaryBase указанный ключ.

IDictionary.IsFixedSize

Получает значение, показывающее, имеет ли объект DictionaryBase фиксированный размер.

IDictionary.IsReadOnly

Возвращает значение, указывающее, является ли объект DictionaryBase доступным только для чтения.

IDictionary.Item[Object]

Возвращает или задает значение, связанное с указанным ключом.

IDictionary.Keys

Получает объект ICollection, содержащий ключи из объекта DictionaryBase.

IDictionary.Remove(Object)

Удаляет элемент с указанным ключом из объекта DictionaryBase.

IDictionary.Values

Получает объект ICollection, содержащий значения из объекта DictionaryBase.

IEnumerable.GetEnumerator()

Возвращает объект IEnumerator, осуществляющий перебор DictionaryBase.

Методы расширения

Cast<TResult>(IEnumerable)

Приводит элементы объекта IEnumerable к заданному типу.

OfType<TResult>(IEnumerable)

Выполняет фильтрацию элементов объекта IEnumerable по заданному типу.

AsParallel(IEnumerable)

Позволяет осуществлять параллельный запрос.

AsQueryable(IEnumerable)

Преобразовывает коллекцию IEnumerable в объект IQueryable.

Применяется к

Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

Потокобезопасность

Открытые статические (Shared в Visual Basic) члены этого типа являются потокобезопасными. Потокобезопасная работа с членами экземпляров типа не гарантируется.

Эта реализация не предоставляет синхронизированную (потокобезопасную) оболочку DictionaryBaseдля , но производные классы могут создавать собственные синхронизированные DictionaryBase версии с помощью SyncRoot свойства .

Перечисление коллекции не является потокобезопасной процедурой. Даже если коллекция синхронизирована, другие потоки могут ее изменить, что приведет к тому, что перечислитель создаст исключение. Для обеспечения потокобезопасности при перечислении можно либо заблокировать коллекцию на все время перечисления, либо перехватывать исключения, возникающие в результате изменений, внесенных другими потоками.

См. также раздел