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

  }

  // В следующих методах реализуется интерфейс 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(), который ради удобства приводится ниже еще раз.

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

public IEnumerator GetEnumerator() {

  foreach(char ch in chrs)

    yield return ch;

}

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

Обозначение yield служит в языке C# в качестве контекстного ключевого слова. Это означает, что оно имеет специальное назначение только в блоке итератора. А вне этого блока оно может быть использовано аналогично любому другому идентификатору.

Следует особо подчеркнуть, что итератор не обязательно должен опираться на массив или коллекцию другого типа. Он должен просто возвращать следующий элемент из совокупности элементов. Это означает, что элементы могут быть построены динамически с помощью соответствующего алгоритма. В качестве примера ниже приведена версия предыдущей программы, в которой возвращаются все буквы английского алфавита, набранные в верхнем регистре. Вместо массива буквы формируются в цикле for.

// Пример динамического построения значений,

// возвращаемых по очереди с помощью итератора.

using System;

using System.Collections;

class MyClass {

  char ch = 'A';

  // Этот итератор возвращает буквы английского

  // алфавита, набранные в верхнем регистре.

  public IEnumerator GetEnumerator() {

    for (int i = 0; i < 26; i++)

      yield return (char)(ch + i);

  }

}

class ItrDemo2 {

  static void Main() {

    MyClass me = new MyClass();

    foreach (char ch in me)

      Console.Write(ch + " ");

    Console.WriteLine();

  }

}

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

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Для преждевременного прерывания итератора служит следующая форма оператора yield.

yield break;

Когда этот оператор выполняется, итератор уведомляет о том, что достигнут конец коллекции. А это, по существу, останавливает сам итератор.

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

// Пример прерывания итератора.

using System;

using System.Collections;

class MyClass {

  char ch = 'A';

  // Этот итератор возвращает первые 10 букв английского алфавита,

  public IEnumerator GetEnumerator() {

    for (int i = 0; i < 26; i++) {