Книга: C# 4.0: полное руководство

Интерфейсы обобщенных коллекций

Интерфейсы обобщенных коллекций

В пространстве имен System.Collections.Generic определен целый ряд интерфейсов обобщенных коллекций, имеющих соответствующие аналоги среди интерфейсов необобщенных коллекций. Все эти интерфейсы сведены в табл. 25.10.

Таблица 25.10. Интерфейсы обобщенных коллекций

Интерфейс -  Описание

lCollection<T> - Определяет основополагающие свойства обобщенных коллекций

IComparer<T> Определяет обобщенный метод Compare() для сравнения объектов, хранящихся в коллекции lDictionary<Tkey, TValue> Определяет обобщенную коллекцию, состоящую из пар “ключ-значение"

IEnumerable<T> - Определяет обобщенный метод GetEnumerator(), предоставляющий перечислитель для любого класса коллекции

Enumerator<T> - Предоставляет методы, позволяющие получать содержимое коллекции по очереди

IEqualityComparer<T> - Сравнивает два объекта на предмет равенства

IList<T> - Определяет обобщенную коллекцию, доступ к которой можно получить с помощью индексатора

В интерфейсе ICollection<T> определен ряд свойств, которые являются общими для всех обобщенных коллекций. Интерфейс ICollection<T> является обобщенным вариантом необобщенного интерфейса ICollection, хотя между ними имеются некоторые отличия.

Итак, в интерфейсе ICollection<T> определены следующие свойства.

int Count { get; }
bool IsReadOnly { get; }

Свойство Count содержит ряд элементов, хранящихся в данный момент в коллекции. А свойство IsReadOnly имеет логическое значение true, если коллекция доступна только для чтения. Если же коллекция доступна как для чтения, так и для записи, то данное свойство имеет логическое значение false.

Кроме того, в интерфейсе ICollection<T> определены перечисленные ниже методы. Обратите внимание на то, что в этом обобщенном интерфейсе определено несколько большее количество методов, чем в его необобщенном аналоге.

Метод - Описание

void Add(T item) - Добавляет элемент item в вызывающую коллекцию. Генерирует исключение NotSupportedException, если коллекция доступна только для чтения

void Clear() - Удаляет все элементы из вызывающей коллекции

bool Contains(T item) - Возвращает логическое значение true, если вызывающая коллекция содержит элемент item, а иначе — логическое значение false

void CopyTo(T[] array,int arraylndex) - Копирует содержимое вызывающей коллекции в массив array, начиная с элемента, указываемого по индексу arraylndex

void Remove(T item) - Удаляет первое вхождение элемента item в вызывающей коллекции. Возвращает логическое значение true, если элемент i tem удален. А если этот элемент не найден в вызывающей коллекции, то возвращается логическое значение false

Некоторые из перечисленных выше методов генерируют исключение NotSupportedException, если коллекция доступна только для чтения.

А поскольку интерфейс ICollection<T> наследует от интерфейсов IEnumerable и IEnumerable<T>, то он включает в себя также обобщенную и необобщенную формы метода GetEnumerator().

Благодаря тому что в интерфейсе ICollection<T> реализуется интерфейс IEnumerable<T>, в нем поддерживаются также методы расширения, определенные в классе Enumerable. Несмотря на то что методы расширения предназначены главным образом для поддержки LINQ, им можно найти и другое применение, в том числе и в коллекциях.

В интерфейсе IList<T> определяется такое поведение обобщенной коллекции, которое позволяет осуществлять доступ к ее элементам по индексу с отсчетом от нуля. Этот интерфейс наследует от интерфейсов IEnumerable, IEnumerable<T> и ICollection<T> и поэтому является обобщенным вариантом необобщенного интерфейса IList. Методы, определенные в интерфейсе IList<T>, перечислены в табл. 25.11. В двух из этих методов предусматривается модификация коллекции. Если же коллекция доступна только для чтения или имеет фиксированный размер, то методы Insert() и RemoveAt() генерируют исключение NotSupportedException.

Таблица 25.11. Методы, определенные в интерфейсе IList<T>

Метод - Описание

int IndexOf(Т item) - Возвращает индекс первого вхождения элемента item в вызывающей коллекции. Если элемент item не обнаружен, то метод возвращает значение -1

void Insert(int index, T item) - Вставляет в вызывающую коллекцию элемент item по индексу index

void RemoveAt(int index) - Удаляет из вызывающей коллекции элемент, расположенный по указанному индексу index

Кроме того, в интерфейсе IList<T> определяется индексатор

Т this[int index] { get; set; }

который устанавливает или возвращает значение элемента коллекции по указанному индексу index.

В интерфейсе IDictionary<TKey, TValue> определяется такое поведение обобщенной коллекции, которое позволяет преобразовать уникальные ключи в соответствующие значения. Это означает, что в данном интерфейсе определяется коллекция, в которой хранятся пары "ключ-значение". Интерфейс IDictionary<TKey, TValue> наследует от интерфейсов IEnumerable, IEnumerable<KeyValuePair<TKey, TValue>> и ICollection<KeyValuePair<TKey, TValue>> и поэтому является обобщенным вариантом необобщенного интерфейса IDictionary. Методы, объявленные в интерфейсе IDictionary<TKey, TValue>, приведены в табл. 25.12. Все эти методы генерируют исключение ArgumentNullException при попытке указать пустой ключ.

Таблица 25.12. Методы, определенные в интерфейсе IDictionaryCTKey, TValue>

Метод - Описание

void Add(TKey key, TValue value) - Добавляет в вызывающую коллекцию пару “ключ-значение”, определяемую параметрами key и value. Генерирует исключение ArgumentException, если ключ key уже находится в коллекции

bool Contains(TKey key) - Возвращает логическое значение true, если вызывающая коллекция содержит элемент key в качестве ключа, а иначе — логическое значение false

bool Remove(TKey key) - Удаляет из коллекции элемент, ключ которого равен значению key

bool TryGetValue(TKey key, out TValue value) - Предпринимает попытку извлечь значение из коллекции по указанному ключу key и присвоить это значение переменной value. При удачном исходе операции возвращается логическое значение true, а иначе — логическое значение false. Если ключ key не найден, переменной value присваивается значение, выбираемое по умолчанию

Кроме того, в интерфейсе IDictionary<TKey, TValue> определены перечисленные ниже свойства.

Свойство - Описание

ICollection Keys<TKey> { get; } Подучает коллекцию ключей

ICollection Values<TValue> { get; } Получает коллекцию значений

Следует иметь в виду, что ключи и значения, содержащиеся в коллекции, доступны отдельными списками с помощью свойств Keys и Values.

И наконец, в интерфейсе IDictionary<TKey, TValue> определяется следующий индексатор.

TValue this[TKey key] { get; set; }

Этот индексатор служит для получения и установки значения элемента коллекции, а также для добавления в коллекцию нового элемента. Следует, однако, иметь в виду, что в качестве индекса в данном случае служит ключ элемента, а не сам индекс.

Интерфейсы IEnumerable<T> и IEnumerator<T> являются обобщенными эквивалентами рассмотренных ранее необобщенных интерфейсов IEnumerable и IEnumerator. В них объявляются аналогичные методы и свойства, да и действуют они по тому же принципу. Разумеется, обобщенные интерфейсы оперируют данными только того типа, который указывается в аргументе типа.

В интерфейсе IEnumerable<T> метод GetEnumerator() объявляется следующим образом.

IEnumerator<T> GetEnumerator()

Этот метод возвращает перечислитель типа Т для коллекции. А это означает, что он возвращает типизированный перечислитель.

Кроме того, в интерфейсе IEnumerable<T> определяются два таких же метода, как и в необобщенном его варианте: MoveNext() и Reset(). В этом интерфейсе объявляется также обобщенный вариант свойства Current.

Т Current { get; }

Это свойство возвращает ссылку типа Т на следующий объект. А это означает, что обобщенный вариант свойства Current является типизированным.

Но между интерфейсами IEnumerator и IEnumerator<T> имеется одно важное различие: интерфейс IEnumerator<T> наследует от интерфейса IDisposable, тогда как интерфейс IEnumerator не наследует от него. В интерфейсе IDisposable определяется метод Dispose(), который служит для освобождения неуправляемых ресурсов.

------------------------------------

ПРИМЕЧАНИЕ

В интерфейсе IEnumerable<T> реализуется также необобщенный интерфейс IEnumerable. Это означает, что в нем поддерживается необобщенный вариант метода GetEnumerator(). Кроме того, в интерфейсе IEnumerable<T> реализуется необобщенный интерфейс IEnumerator, а следовательно, в нем поддерживаются необобщенные варианты свойства Current.

------------------------------------

Интерфейс IComparer<Т> является обобщенным вариантом рассмотренного ранее интерфейса IComparer. Главное отличие между ними заключается в том, что интерфейс IComparer<T> обеспечивает типовую безопасность. В нем обобщенный вариант метода Compare() объявляется следующим образом.

int Compare(Т х, Т у)

В этом методе сравниваются объекты х и у. Он возвращает положительное значение, если значение объекта х больше, чем у объекта у; отрицательное — если значение объекта х меньше, чем у объекта у; и нулевое значение — если сравниваемые значения равны.

Интерфейс IEqualityComparer<T> полностью соответствует своему необобщенному аналогу EqualityComparer. В нем определяются два следующих метода.

bool Equals(Т х, Т у)
int GetHashCode(Т obj)

Метод Equals() должен возвратить логическое значение true, если значения объектов х и у равны. А метод GetHashCode() возвращает хеш-код для объекта obj. Если два сравниваемых объекта равны, то их хеш-коды также должны быть одинаковы.

Интерфейс ISet<T> был добавлен в версию 4.0 среды .NET Framework. Он определяет поведение обобщенной коллекции, реализующей ряд уникальных элементов. Этот интерфейс наследует от интерфейсов IEnumerable, IEnumerable<T>, а также ICollection<T>. В интерфейсе ISet<T> определен ряд методов, перечисленных в табл. 25.13. Обратите внимание на то, что параметры этих методов указываются как относящиеся к типу IEnumerable<T>. Это означает, что в качестве второго аргумента методу можно передать нечто, отличающееся от объектов типа ISet<T>. Но чаще всего оба аргумента оказываются экземплярами объектов типа ISet<T>.

Таблица 25.13. Методы, определенные в интерфейсе ISet<T>

Метод - Описание

void ExceptWith(Ienumerable<T> other) - Удаляет из вызывающего множества те элементы, которые содержатся в другом множестве other

void IntersectWith(IEnumerable<T> other) - После вызова этого метода вызывающее множество содержит пересечение своих элементов с элементами другого множества other

bool IsProperSubsetOf(IEnumerable<T> other) - Возвращает логическое значение true, если вызывающее множество является правильным подмножеством другого множества other, а иначе — логическое значение false

bool IsProperSupersetOf(lEnumerable<T> other) - возвращает логическое значение true, если вызывающее множество является правильным надмножеством другого множества other, а иначе — логическое значение false

bool IsSubsetOf(IEnumerable<T> other) - Возвращает логическое значение true, если вызывающее множество является подмножеством другого множества other, а иначе — логическое значение false

bool IsSupersetOf(IEnumerable<T> other) - Возвращает логическое значение true, если вызывающее множество является надмножеством другого множества other, а иначе — логическое значение false

bool Overlaps(IEnumerable<T> other) - Возвращает логическое значение true, если вызывающее множество и другое множество other содержат хотя бы один общий элемент, а иначе — логическое значение false

bool SetEquals(IEnumerable<T> other) - Возвращает логическое значение true, если все элементы вызывающего множества и другого множества other оказываются общими, а иначе —логическое значение false. Порядок расположения элементов не имеет значения, а дублирующиеся элементы во другом множестве other игнорируются

void SymmetricExceptWith (IEnumerable<T> other) - После вызова этого метода вызывающее множество будет содержать симметрическую разность своих элементов и элементов другого множества other

void UnionWith(IEnumerable<T> other) - После вызова этого метода вызывающее множество будет содержать объединение своих элементов и элементов другого множества other

Оглавление книги