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

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

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

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

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

// Реализовать интерфейссы IEnumerable и IEnumerator
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++;
    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.

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