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 to 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 ogólnych modułów wyliczania.

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 użycie foreach jest zalecane, zamiast bezpośrednio manipulować modułem wyliczającym.

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.

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ć metodę MoveNext , aby przejść do pierwszego elementu kolekcji przed odczytaniem wartości Current.

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

Jeśli MoveNext przejdzie koniec kolekcji, moduł wyliczający jest umieszczony po ostatnim elemecie w kolekcji i MoveNext zwraca wartość false. Gdy moduł wyliczający znajduje się na tym stanowisku, kolejne wywołania zwracają MoveNext również polecenie false. Jeśli ostatnie wywołanie, które MoveNext ma być zwrócone false, Current jest niezdefiniowane. Nie można ponownie ustawić Current pierwszego elementu kolekcji. Zamiast tego należy utworzyć nowe wystąpienie modułu wyliczającego.

Metoda Reset jest dostarczana na potrzeby współdziałania modelu COM. Nie musi być zaimplementowana; Zamiast tego implementator może po prostu zgłosić element NotSupportedException. Jeśli jednak zdecydujesz się to zrobić, upewnij się, że żadne osoby wywołujące nie korzystają z Reset funkcji.

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 w kolekcji nie jest wewnętrznie procedurą odporną na wielowątkowość. Aby zagwarantować bezpieczeństwo wątków podczas wyliczania, można zablokować kolekcję podczas całego procesu wyliczania. Aby zezwolić wielu wątkom na dostęp do kolekcji w celu odczytu i zapisu danych, należy zaimplementować własny mechanizm synchronizacji.

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

Uwagi dotyczące implementowania

Implementacja tego interfejsu wymaga zaimplementowania niegenericznego IEnumerator interfejsu. Metody MoveNext() i Reset() nie zależą od Tmetody i są wyświetlane tylko w przypadku interfejsu niegenericznego. Właściwość jest wyświetlana Current w obu interfejsach i ma różne typy zwracane. Zaimplementuj właściwość niegeneryczną 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 IDisposablemetodę Dispose() , która wymaga zaimplementowania metody . Dzięki temu można zamknąć połączenia z bazą danych lub obsługiwać pliki wydania lub podobne operacje podczas korzystania z innych zasobów. Jeśli nie ma dodatkowych zasobów do usunięcia, podaj pustą Dispose() implementację.

Właściwości

Current

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

Metody

Dispose()

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

(Odziedziczone po IDisposable)
MoveNext()

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

(Odziedziczone po IEnumerator)
Reset()

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

(Odziedziczone po IEnumerator)

Dotyczy

Zobacz też