IEnumerator Interfejs

Definicja

Obsługuje prostą iterację w kolekcji nieogólnej.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
Pochodne
Atrybuty

Przykłady

Poniższy przykład kodu demonstruje implementację IEnumerable interfejsów i IEnumerator dla kolekcji niestandardowej.The following code example demonstrates the implementation of the IEnumerable and IEnumerator interfaces for a custom collection. W tym przykładzie elementy członkowskie tych interfejsów nie są jawnie wywoływane, ale są zaimplementowane do obsługi użycia foreach (for each w Visual Basic) do iteracji w kolekcji.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.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

Uwagi

IEnumeratorjest interfejsem podstawowym dla wszystkich nieogólnych modułów wyliczających.IEnumerator is the base interface for all non-generic enumerators. Jego ogólny odpowiednik jest System.Collections.Generic.IEnumerator<T> interfejsem.Its generic equivalent is the System.Collections.Generic.IEnumerator<T> interface.

Instrukcja języka(for each w Visual Basic) ukrywa złożoność modułów wyliczających. C# foreachThe foreach statement of the C# language (for each in Visual Basic) hides the complexity of the enumerators. W związku z foreach tym użycie jest zalecane zamiast bezpośredniego manipulowania modułem wyliczania.Therefore, using foreach is recommended instead of directly manipulating the enumerator.

Moduły wyliczające mogą służyć do odczytu danych w kolekcji, ale nie można za ich pomocą modyfikować kolekcji źródłowej.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Metoda jest zapewniana dla współdziałania modelu COM i nie musi być w pełni zaimplementowana; zamiast tego implementacja może NotSupportedExceptionzgłosić. ResetThe Reset method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a NotSupportedException.

Początkowo moduł wyliczający jest umieszczony przed pierwszym elementem w kolekcji.Initially, the enumerator is positioned before the first element in the collection. Należy wywołać MoveNext metodę, aby przefiltrować moduł do pierwszego elementu kolekcji przed przeczytaniem Currentwartości; w przeciwnym razie Current jest niezdefiniowana.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.

Currentzwraca ten sam obiekt do MoveNext momentu Reset wywołania metody lub.Current returns the same object until either MoveNext or Reset is called. MoveNextustawia Current do następnego elementu.MoveNext sets Current to the next element.

Jeśli MoveNext przekazuje koniec kolekcji, moduł wyliczający jest umieszczony po ostatnim elemencie w kolekcji i MoveNext zwraca false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Gdy moduł wyliczający znajduje się w tym miejscu, kolejne MoveNext wywołania również falsezwracają.When the enumerator is at this position, subsequent calls to MoveNext also return false. Jeśli ostatnie wywołanie MoveNext zwrócone false, Current nie jest zdefiniowane.If the last call to MoveNext returned false, Current is undefined.

Aby ponownie Current ustawić na pierwszy element kolekcji, można wywołać Reset, jeśli MoveNextjest zaimplementowany, a następnie.To set Current to the first element of the collection again, you can call Reset, if it's implemented, followed by MoveNext. Jeśli Reset nie jest zaimplementowany, należy utworzyć nowe wystąpienie modułu wyliczającego, aby powrócić do pierwszego elementu kolekcji.If Reset is not implemented, you must create a new enumerator instance to return to the first element of the collection.

Jeśli w kolekcji zostaną wprowadzone zmiany, takie jak dodawanie, modyfikowanie lub usuwanie elementów, zachowanie modułu wyliczającego jest niezdefiniowane.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

Moduł wyliczający nie ma wyłącznego dostępu do kolekcji, w związku z tym wyliczanie w kolekcji nie jest wewnętrznie procedurą odporną na wielowątkowość.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Nawet gdy kolekcja jest synchronizowana, inne wątki nadal mogą ją modyfikować. Powoduje to zgłaszanie wyjątku przez moduł wyliczający.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Aby zagwarantować bezpieczeństwo wątków podczas wyliczania, można zablokować kolekcję podczas całego procesu wyliczania albo rejestrować wyjątki wynikłe ze zmian wprowadzanych przez inne wątków.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.

Właściwości

Current

Pobiera element w kolekcji na bieżącym miejscu modułu wyliczającego.Gets the element in the collection at the current position of the enumerator.

Metody

MoveNext()

Przesuwa moduł wyliczający do następnego elementu kolekcji.Advances the enumerator to the next element of the collection.

Reset()

Ustawia początkową pozycję modułu wyliczającego, która jest wcześniejsza niż pierwszy element w kolekcji.Sets the enumerator to its initial position, which is before the first element in the collection.

Dotyczy

Zobacz też