Udostępnij za pośrednictwem

IEnumerator<T> Interfejs

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Collections.Generic
Zestaw:
System.Runtime.dll
Zestaw:
mscorlib.dll
Zestaw:
netstandard.dll

Obsługuje prostą iterację w kolekcji ogólnej.

generic <typename T>
public interface class IEnumerator : IDisposable, System::Collections::IEnumerator
public interface IEnumerator<out T> : IDisposable, System.Collections.IEnumerator
public interface IEnumerator<T> : IDisposable, System.Collections.IEnumerator
type IEnumerator<'T> = interface
    interface IEnumerator
    interface IDisposable
type IEnumerator<'T> = interface
    interface IDisposable
    interface IEnumerator
Public Interface IEnumerator(Of Out T)
Implements IDisposable, IEnumerator
Public Interface IEnumerator(Of T)
Implements IDisposable, IEnumerator

Parametry typu

T

Typ obiektów do wyliczenia.

Ten parametr typu jest kowariantny. Oznacza to, że możesz użyć typu, który został przez Ciebie określony, lub dowolnego typu, który jest bardziej pochodny. Aby uzyskać więcej informacji o kowariancji i kontrawariancji, zobacz Kowariancja i kontrawariancja w typach ogólnych.
Pochodne
Implementuje
IEnumerator IDisposable

Przykłady

Poniższy przykład przedstawia implementację interfejsu IEnumerator<T> dla klasy kolekcji obiektów niestandardowych. Obiekt niestandardowy jest wystąpieniem typu Box, a klasa kolekcji jest BoxCollection. Ten przykład kodu jest częścią większego przykładu udostępnionego dla interfejsu ICollection<T>.


// Defines the enumerator for the Boxes collection.
// (Some prefer this class nested in the collection class.)
public class BoxEnumerator : IEnumerator<Box>
{
    private BoxCollection _collection;
    private int curIndex;
    private Box curBox;

    public BoxEnumerator(BoxCollection collection)
    {
        _collection = collection;
        curIndex = -1;
        curBox = default(Box);
    }

    public bool MoveNext()
    {
        //Avoids going beyond the end of the collection.
        if (++curIndex >= _collection.Count)
        {
            return false;
        }
        else
        {
            // Set current box to next item in collection.
            curBox = _collection[curIndex];
        }
        return true;
    }

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

    void IDisposable.Dispose() { }

    public Box Current
    {
        get { return curBox; }
    }

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

' Defines the enumerator for the Boxes collection.
' (Some prefer this class nested in the collection class.)
Public Class BoxEnumerator
    Implements IEnumerator(Of Box)
    Private _collection As BoxCollection
    Private curIndex As Integer
    Private curBox As Box


    Public Sub New(ByVal collection As BoxCollection)
        MyBase.New()
        _collection = collection
        curIndex = -1
        curBox = Nothing

    End Sub

    Private Property Box As Box
    Public Function MoveNext() As Boolean _
        Implements IEnumerator(Of Box).MoveNext
        curIndex = curIndex + 1
        If curIndex = _collection.Count Then
            ' Avoids going beyond the end of the collection.
            Return False
        Else
            'Set current box to next item in collection.
            curBox = _collection(curIndex)
        End If
        Return True
    End Function

    Public Sub Reset() _
        Implements IEnumerator(Of Box).Reset
        curIndex = -1
    End Sub

    Public Sub Dispose() _
        Implements IEnumerator(Of Box).Dispose

    End Sub

    Public ReadOnly Property Current() As Box _
        Implements IEnumerator(Of Box).Current

        Get
            If curBox Is Nothing Then
                Throw New InvalidOperationException()
            End If

            Return curBox
        End Get
    End Property

    Private ReadOnly Property Current1() As Object _
        Implements IEnumerator.Current

        Get
            Return Me.Current
        End Get
    End Property
End Class

' Defines two boxes as equal if they have the same dimensions.
Public Class BoxSameDimensions
    Inherits EqualityComparer(Of Box)

    Public Overrides Function Equals(ByVal b1 As Box, ByVal b2 As Box) As Boolean
        If b1.Height = b2.Height And b1.Length = b2.Length And b1.Width = b2.Width Then
            Return True
        Else
            Return False
        End If
    End Function

    Public Overrides Function GetHashCode(ByVal bx As Box) As Integer
        Dim hCode As Integer = bx.Height ^ bx.Length ^ bx.Width
        Return hCode.GetHashCode()
    End Function
End Class

Uwagi

IEnumerator<T> jest interfejsem podstawowym dla wszystkich modułów wyliczania ogólnego.

Instrukcja foreach języka C# (for each w języku C++, For Each w Visual Basic) ukrywa złożoność modułów wyliczania. W związku z tym zaleca się użycie foreach zamiast bezpośredniego manipulowania modułem wyliczającym.

Moduły wyliczania mogą służyć do odczytywania danych w kolekcji, ale nie mogą być używane do modyfikowania podstawowej kolekcji.

Początkowo moduł wyliczający jest umieszczony przed pierwszym elementem w kolekcji. Na tym stanowisku Current jest niezdefiniowany. W związku z tym należy wywołać MoveNext, aby przejść do pierwszego elementu kolekcji przed odczytaniem wartości Current.

Current zwraca ten sam obiekt do momentu wywołania MoveNext. MoveNext ustawia Current na następny element.

Jeśli MoveNext przechodzi na końcu kolekcji, moduł wyliczający jest umieszczony po ostatnim elemenie w kolekcji i MoveNext zwraca wartość false. Gdy moduł wyliczający znajduje się na tym stanowisku, kolejne wywołania MoveNext również zwracają false. Jeśli ostatnie wywołanie MoveNext zwróciło false, Current jest niezdefiniowany. Nie można ponownie ustawić Current na pierwszy element kolekcji; Zamiast tego należy utworzyć nowe wystąpienie modułu wyliczającego.

Metoda Reset jest udostępniana na potrzeby współdziałania modelu COM. Nie musi być wdrażana; Zamiast tego implementator może po prostu zgłosić NotSupportedException. Jeśli jednak zdecydujesz się to zrobić, upewnij się, że żaden obiekt wywołujący nie korzysta z funkcji Reset.

Jeśli zmiany są wprowadzane do kolekcji, takie jak dodawanie, modyfikowanie lub usuwanie elementów, zachowanie modułu wyliczającego jest niezdefiniowane.

Moduł wyliczający nie ma wyłącznego dostępu do kolekcji; w związku z tym wyliczanie za pośrednictwem kolekcji nie jest wewnętrznie procedurą bezpieczną wątkowo. Aby zagwarantować bezpieczeństwo wątków podczas wyliczania, możesz zablokować kolekcję podczas całego wyliczenia. Aby umożliwić dostęp do kolekcji przez wiele wątków do odczytu i zapisu, należy zaimplementować własną synchronizację.

Domyślne implementacje kolekcji w przestrzeni nazw System.Collections.Generic nie są synchronizowane.

Uwagi dotyczące implementowania

Zaimplementowanie tego interfejsu wymaga zaimplementowania niegenericznego interfejsu IEnumerator. Metody MoveNext() i Reset() nie zależą od Ti są wyświetlane tylko w przypadku interfejsu niegenericznego. Właściwość Current jest wyświetlana w obu interfejsach i ma różne typy zwracane. Zaimplementuj niegeneryczną właściwość Current jako jawną implementację interfejsu. Dzięki temu każdy użytkownik interfejsu niegenericznego może korzystać z interfejsu ogólnego.

Ponadto IEnumerator<T> implementuje IDisposable, co wymaga zaimplementowania metody Dispose(). Umożliwia to zamknięcie połączeń bazy danych lub dojść do plików wydania lub podobnych operacji podczas korzystania z innych zasobów. Jeśli nie ma dodatkowych zasobów do usunięcia, podaj pustą implementację Dispose().

Właściwości

Current

Pobiera element w kolekcji na bieżącej pozycji modułu wyliczającego.

Metody

Dispose()

Wykonuje zadania zdefiniowane przez aplikację skojarzone z zwalnianiem, wydawaniem lub resetowaniem niezarządzanych zasobów.

(Odziedziczone po IDisposable)
MoveNext()

Przechodzi moduł wyliczający do następnego elementu kolekcji.

(Odziedziczone po IEnumerator)
Reset()

Ustawia moduł wyliczający na swoją początkową pozycję, która znajduje się przed pierwszym elementem w kolekcji.

(Odziedziczone po IEnumerator)

Dotyczy

Zobacz też