IEnumerator IEnumerator IEnumerator IEnumerator Interface

Определение

Поддерживает простой перебор по неуниверсальной коллекции.Supports a simple iteration over a non-generic collection.

public interface class IEnumerator
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("496B0ABF-CDEE-11d3-88E8-00902754C43A")]
public interface IEnumerator
type IEnumerator = interface
Public Interface IEnumerator
Производный
Атрибуты

Примеры

В следующем примере кода демонстрируется реализация IEnumerable и IEnumerator интерфейсы для пользовательской коллекции.The following code example demonstrates the implementation of the IEnumerable and IEnumerator interfaces for a custom collection. В этом примере элементы этого интерфейса не указаны явно, но они реализуются для поддержки использования foreach (for each в Visual Basic) для выполнения итерации по коллекции.In this example, members of these interfaces are not explicitly called, but they are implemented to support the use of foreach (for each in Visual Basic) to iterate through the collection.

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

// Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
       return (IEnumerator) GetEnumerator();
    }

    public PeopleEnum GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
    public Person[] _people;

    // Enumerators are positioned before the first element
    // until the first MoveNext() call.
    int position = -1;

    public PeopleEnum(Person[] list)
    {
        _people = list;
    }

    public bool MoveNext()
    {
        position++;
        return (position < _people.Length);
    }

    public void Reset()
    {
        position = -1;
    }

    object IEnumerator.Current
    {
        get
        {
            return Current;
        }
    }

    public Person Current
    {
        get
        {
            try
            {
                return _people[position];
            }
            catch (IndexOutOfRangeException)
            {
                throw new InvalidOperationException();
            }
        }
    }
}

class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);

    }
}

/* This code produces output similar to the following:
 *
 * John Smith
 * Jim Johnson
 * Sue Rabon
 *
 */
Imports System
Imports System.Collections

' Simple business object.
Public Class Person

    Public Sub New(ByVal fName As String, ByVal lName As String)
        Me.firstName = fName
        Me.lastName = lName
    End Sub


    Public firstName As String
    Public lastName As String
End Class

' Collection of Person objects, which implements IEnumerable so that
' it can be used with ForEach syntax.
Public Class People
    Implements IEnumerable

    Private _people() As Person

    Public Sub New(ByVal pArray() As Person)
        _people = New Person(pArray.Length - 1) {}

        Dim i As Integer
        For i = 0 To pArray.Length - 1
            _people(i) = pArray(i)
        Next i
    End Sub

    ' Implementation of GetEnumerator.
    Public Function GetEnumerator() As IEnumerator _
      Implements IEnumerable.GetEnumerator

        Return New PeopleEnum(_people)
    End Function

End Class

' When you implement IEnumerable, you must also implement IEnumerator.
Public Class PeopleEnum
    Implements IEnumerator

    Public _people() As Person

    ' Enumerators are positioned before the first element
    ' until the first MoveNext() call.
    Dim position As Integer = -1

    Public Sub New(ByVal list() As Person)
        _people = list
    End Sub

    Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
        position = position + 1
        Return (position < _people.Length)
    End Function

    Public Sub Reset() Implements IEnumerator.Reset
        position = -1
    End Sub

    Public ReadOnly Property Current() As Object Implements IEnumerator.Current
        Get
            Try
                Return _people(position)
            Catch ex As IndexOutOfRangeException
                Throw New InvalidOperationException()
            End Try
        End Get
    End Property
End Class

Class App
    Shared Sub Main()
        Dim peopleArray() As Person = { _
            New Person("John", "Smith"), _
            New Person("Jim", "Johnson"), _
            New Person("Sue", "Rabon")}

        Dim peopleList As New People(peopleArray)
        Dim p As Person
        For Each p In peopleList
            Console.WriteLine(p.firstName + " " + p.lastName)
        Next

    End Sub
End Class

' This code produces output similar to the following:
' 
' John Smith
' Jim Johnson
' Sue Rabon

Комментарии

IEnumerator является базовым интерфейсом для всех неуниверсальных перечислителей.IEnumerator is the base interface for all non-generic enumerators. Его универсальный эквивалент — System.Collections.Generic.IEnumerator<T> интерфейс.Its generic equivalent is the System.Collections.Generic.IEnumerator<T> interface.

Инструкция foreach языка C# (for each в Visual Basic) позволяет скрыть сложный механизм перечислителей.The foreach statement of the C# language (for each in Visual Basic) hides the complexity of the enumerators. Таким образом, использование foreach рекомендуется вместо непосредственного использования перечислителя.Therefore, using foreach is recommended instead of directly manipulating the enumerator.

Перечислители могут использоваться для чтения данных в коллекции, но не для ее изменения.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Reset Метод предоставляется для COM-взаимодействия и не должны быть полностью реализованы; вместо этого разработчик может вызвать исключение NotSupportedException.The Reset method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a NotSupportedException.

Изначально перечислитель располагается перед первым элементом коллекции.Initially, the enumerator is positioned before the first element in the collection. Необходимо вызвать MoveNext метод, чтобы переместить перечислитель на первый элемент коллекции до считывания значения свойства Current; в противном случае Current не определено.You must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current; otherwise, Current is undefined.

Current возвращает тот же объект, пока не будет вызван метод MoveNext или Reset.Current returns the same object until either MoveNext or Reset is called. MoveNext задает Current в качестве значения для следующего элемента.MoveNext sets Current to the next element.

Если MoveNext передает в конец коллекции, перечислитель помещается за последним элементом в коллекции и MoveNext возвращает false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Если перечислитель находится в этой позиции, последующие вызовы MoveNext также возвращать false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Если последний вызов MoveNext возвращается false, Current не определено.If the last call to MoveNext returned false, Current is undefined.

Чтобы задать Current на первый элемент в коллекцию еще раз, можно вызвать Reset, если он реализован, за которым следует MoveNext.To set Current to the first element of the collection again, you can call Reset, if it's implemented, followed by MoveNext. Если Reset является не реализован, необходимо создать новый экземпляр перечислителя для возврата на первый элемент коллекции.If Reset is not implemented, you must create a new enumerator instance to return to the first element of the collection.

При внесении изменений в коллекцию, например добавление, изменение или удаление элементов, перечислитель поведение не определено.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

У перечислителя нет эксклюзивного доступа к коллекции, поэтому перечисление коллекции не является потокобезопасной процедурой.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Даже если коллекция синхронизирована, другие потоки могут ее изменить, что приведет к тому, что перечислитель создаст исключение.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Для обеспечения потокобезопасности при перечислении можно либо заблокировать коллекцию на все время перечисления, либо перехватывать исключения, возникающие в результате изменений, внесенных другими потоками.To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

Свойства

Current Current Current Current

Возвращает элемент коллекции, соответствующий текущей позиции перечислителя.Gets the element in the collection at the current position of the enumerator.

Методы

MoveNext() MoveNext() MoveNext() MoveNext()

Перемещает перечислитель к следующему элементу коллекции.Advances the enumerator to the next element of the collection.

Reset() Reset() Reset() Reset()

Устанавливает перечислитель в его начальное положение, т. е. перед первым элементом коллекции.Sets the enumerator to its initial position, which is before the first element in the collection.

Применяется к

Дополнительно