Герберт Шилдт - C# 4.0 полное руководство - 2011

DictionaryEntry Entry { get; }

Свойство Entry позволяет получить пару "ключ-значение7' из перечислителя в форме структуры DictionaryEntry. Напомним, что в структуре DictionaryEntry определяются два свойства, Key и Value, с помощью которых можно получать доступ к ключу или значению, связанному с элементом коллекции. Ниже приведены два других свойства, определяемых в интерфейсе IDictionaryEnumerator.

object Key { get; } object Value { get; }

С помощью этих свойств осуществляется непосредственный доступ к ключу или значению.

Перечислитель типа IDictionaryEnumerator используется аналогично обычному перечислителю, за исключением того, что текущее значение в данном случае получается с помощью свойств Entry, Key или Value, а не свойства Current. Следовательно, приобретя перечислитель типа IDictionaryEnumerator, необходимо вызвать метод MoveNext (), чтобы получить первый элемент коллекции. А для получения остальных ее элементов следует продолжить вызовы метода MoveNext (). Этот метод возвращает логическое значение false, когда в коллекции больше нет ни одного элемента.

В приведенном ниже примере программы элементы коллекции типа Hashtable перечисляются с помощью перечислителя типа IDictionaryEnumerator.

// Продемонстрировать применение перечислителя типа IDictionaryEnumerator.

using System;

using System.Collections;

class IDicEnumDemo { static void Main() {

// Создать хеш-таблицу.

Hashtable ht = new Hashtable();

// Добавить элементы в таблицу, ht.Add("Кен", "555-7756"); ht.Add("Мэри", "555-9876"); ht.Add("Том", "555-3456"); ht.Add("Тодд", "555-3452");

// Продемонстрировать применение перечислителя.

IDictionaryEnumerator etr = ht.GetEnumerator();

Console.WriteLine("Отобразить информацию с помощью свойства Entry."); while(etF.MoveNext())

Console.WriteLine(etr.Entry.Key + ": " + etr.Entry.Value);

Console.WriteLine();

Console.WriteLine("Отобразить информацию " +

"с помощью свойств Key и Value.");

etr .Reset () ;

while(etr.MoveNext ())

Console.WriteLine(etr.Key + ": " + etr.Value);

}

}

Ниже приведен результат выполнения этой программы.

Отобразить информацию с помощью свойства Entry.

Мэри: 555-9876 Том: 555-3456 Тодд: 555-3452 Кен: 555-7756

Отобразить информацию с помощью свойств Key и Value.

Мэри: 555-9876 Том: 555-3456 Тодд: 555-3452 Кен: 555-7756

Реализация интерфейсов IEnumerable и IEnumerator

Как упоминалось выше, для циклического обращения к элементам коллекции зачастую проще (да и лучше) организовать цикл foreach, чем пользоваться непосредственно методами интерфейса IEnumerator. Тем не менее ясное представление о принципе действия подобных интерфейсов важно иметь по еще одной причине: если требуется создать класс, содержащий объекты, перечисляемые в цикле foreach, то в этом классе следует реализовать интерфейсы IEnumerator и IEnumerable. Иными словами, для того чтобы обратиться к объекту определяемого пользователем класса в цикле foreach, необходимо реализовать интерфейсы IEnumerator и IEnumerable в их обобщенной или необобщенной форме. Правда, сделать это будет нетрудно, поскольку оба интерфейса не очень велики.

В приведенном ниже примере программы интерфейсы IEnumerator и IEnumerable реализуются в необобщенной форме, с тем чтобы перечислить содержимое массива, инкапсулированного в классе MyClass.

using System;

using System.Collections;

class MyClass : IEnumerator,    IEnumerable {

char[] chrs = {    'А',    'В',    'C',    'D'    };

int idx = -1;

// Реализовать интерфейс IEnumerable. public IEnumerator GetEnumerator()    {

return this;

}

// В следующих методах реализуется интерфейс IEnumerator

// Возвратить текущий объект, public object Current { get {

return chrs[idx];

}

}

// Перейти к следующему объекту, public bool MoveNext() { if(idx == chrs.Length-1) {

Reset(); // установить перечислитель в конец return false;

}

idx++;

f

return true;

}

// Установить перечислитель в начало, public void Reset() { idx = -1; }

}

class EnumeratorlmplDemo { static void Main() {

MyClass me = new MyClass();

// Отобразить содержимое объекта me. foreach(char ch in me)

Console .Write (ch + 11 11);

Console.WriteLine();

// Вновь отобразить содержимое объекта me. foreach(char ch in me)

Console .Write (ch + 11 ");

Console.WriteLine();

}

}

Эта программа дает следующий результат.

А В С D А В С D

В данной программе сначала создается класс MyClass, в котором инкапсулируется небольшой массив типа char, состоящий из символов А-D. Индекс этого массива хранится в переменной idx, инициализируемой значением -1. Затем в классе MyClass реализуются оба интерфейса, IEnumerator и IEnumerable. Метод GetEnumerator () возвращает ссылку на перечислитель, которым в данном случае оказывается текущий объект. Свойство Current возвращает следующий символ в массиве, т.е. объект, указываемый по индексу idx. Метод MoveNext () перемещает индекс idx в следующее положение. Этот метод возвращает логическое значение false, если достигнут конец коллекции, в противном случае — логическое значение true. Напомним, что перечислитель оказывается неопределенным вплоть до первого вызова метода MoveNext (). Следовательно, метод MoveNext () автоматически вызывается в цикле foreach перед обращением к свойству Current. Именно поэтому первоначальное значение переменной idx устанавливается равным -1. Оно становится равным нулю на первом шаге цикла foreach. Обобщенная реализация рассматриваемых здесь интерфейсов будет действовать по тому же самому принципу.

Далее в методе Main () создается объект тс типа MyClass, и содержимое этого объекта дважды отображается в цикле foreach.

Применение итераторов

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

Обратимся сначала к простому примеру итератора. Приведенная ниже программа является измененной версией предыдущей программы, в которой вместо явной реализации интерфейсов IEnumerator и IEnumerable применяется итератор.

// Простой пример применения итератора.

using System;

using System.Collections;

class MyClass {

char[] chrs = { fAf, fBf, 'C1,    'D'    };

// Этот итератор возвращает символы из массива chrs. public IEnumerator GetEnumerator()    {

foreach(char ch in chrs) yield return ch;

}

}

class ItrDemo {

static void Main() {

MyClass me = new MyClassO;

foreach(char ch in me)

Console .Write (ch + 11 ");

Console.WriteLine();

}

}

При выполнении этой программы получается следующий результат.

А В С D

Как видите, содержимое массива me. chrs перечислено.

Рассмотрим эту программу более подробно. Во-первых, обратите внимание на то, что в классе MyClass не указывается IEnumerator в качестве реализуемого интерфейса. При создании итератора компилятор реализует этот интерфейс автоматически. И во-вторых, обратите особое внимание на метод GetEnumerator (), который ради удобства приводится ниже еще раз.

// Этот итератор возвращает символы из массива chrs. public IEnumerator GetEnumerator()    {

foreach(char ch in chrs) yield return ch;

}

Это и есть итератор для объектов класса MyClass. Как видите, в нем явно реализуется метод GetEnumerator (), определенный в интерфейсе IEnumerable. А теперь перейдем непосредственно к телу данного метода. Оно состоит из цикла foreach, в котором возвращаются элементы из массива chrs. И делается это с помощью оператора yield return. Этот оператор возвращает следующий объект в коллекции, которым в данном случае оказывается очередной символ в массиве chrs. Благодаря этому средству обращение к объекту тс типа MyClass организуется в цикле foreach внутри метода Main ().