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

  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++;

    return true;

  }

  // Установить перечислитель в начало,

  public void Reset() {

    idx = -1;

  }

}

class EnumeratorlmplDemo {

  static void Main() {

    MyClass mc = new MyClass();

    // Отобразить содержимое объекта me.

    foreach (char ch in me)

      Console.Write(ch + " ");

    Console.WriteLine();

    // Вновь отобразить содержимое объекта me.

    foreach (char ch in mc)

      Console.Write(ch + " ");

    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() создается объект mc типа MyClass, и содержимое этого объекта дважды отображается в цикле foreach.

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

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

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

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

using System;

using System.Collections;

class MyClass {

  char[] chrs = { 'A', 'B', 'C', 'D' };

  // Этот итератор возвращает символы из массива chrs.

  public IEnumerator GetEnumerator() {

    foreach (char ch in chrs)

      yield return ch;

  }

}

class ItrDemo {

  static void Main() {

    MyClass mc = new MyClass();

    foreach (char ch in mc)

      Console.Write(ch + " ");

    Console.WriteLine();

  }

}

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

А В С D

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

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