IEnumerator<T> Schnittstelle

  • Referenz

Definition

Namespace:
System.Collections.Generic
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Unterstützt eine einfache Iteration durch eine generische Auflistung.

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

Typparameter

T

Der Typ der aufzulistenden Objekte.

Dieser Typparameter ist kovariant. Das bedeutet, dass Sie entweder den angegebenen Typ oder einen stärker abgeleiteten Typ verwenden können. Weitere Informationen zu Kovarianz und Kontravarianz finden Sie unter Kovarianz und Kontravarianz in Generics.
Abgeleitet
Implementiert
IEnumerator IDisposable

Beispiele

Das folgende Beispiel zeigt eine Implementierung der IEnumerator<T> Schnittstelle für eine Auflistungsklasse benutzerdefinierter Objekte. Das benutzerdefinierte Objekt ist ein instance des TypsBox, und die Auflistungsklasse ist BoxCollection. Dieses Codebeispiel ist Teil eines größeren Beispiels für die ICollection<T> Schnittstelle.


// 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

Hinweise

IEnumerator<T> ist die Basisschnittstelle für alle generischen Enumeratoren.

Die foreach Anweisung der C#-Sprache (for each in C++, For Each in Visual Basic) blendet die Komplexität der Enumeratoren aus. Daher empfiehlt es sich, foreach zu verwenden und den Enumerator nicht direkt zu ändern.

Mit Enumeratoren können die Daten in der Auflistung zwar gelesen, jedoch nicht zum Ändern der zugrunde liegenden Auflistung verwendet werden.

Zu Beginn wird der Enumerator vor das erste Element in der Auflistung positioniert. An dieser Position ist Current nicht definiert. Daher muss der Enumerator durch einen Aufruf von MoveNext auf das erste Element der Auflistung gesetzt werden, bevor der Wert von Current gelesen werden kann.

Current gibt solange dasselbe Objekt zurück, bis MoveNext aufgerufen wird. MoveNext legt Current auf das nächste Element fest.

Wenn MoveNext das Ende der Auflistung übergibt, wird der Enumerator hinter dem letzten Element in der Auflistung platziert, und MoveNext gibt false zurück. Wenn sich der Enumerator an dieser Position befindet, geben nachfolgende Aufrufe von MoveNext auch false zurück. Wenn der letzte Aufruf MoveNext zurückgegebene false, Current ist nicht definiert. Sie können Current nicht erneut auf das erste Element der Auflistung festlegen, sondern müssen eine neue Enumeratorinstanz erstellen.

Die Reset Methode wird für die COM-Interoperabilität bereitgestellt. Sie muss nicht unbedingt umgesetzt werden; Stattdessen kann der Implementierer einfach einen NotSupportedExceptionauslösen. Wenn Sie dies jedoch tun, sollten Sie sicherstellen, dass sich keine Anrufer auf die Reset Funktionalität verlassen.

Wenn Änderungen an der Auflistung vorgenommen werden, z. B. das Hinzufügen, Ändern oder Löschen von Elementen, ist das Verhalten des Enumerators nicht definiert.

Der Enumerator hat keinen exklusiven Zugriff auf die Auflistung; daher ist die Enumeration einer Auflistung systembedingt kein threadsicheres Verfahren. Um während der Enumeration Threadsicherheit zu garantieren, können Sie die Auflistung während der gesamten Enumeration sperren. Um den Lese- und Schreibzugriff auf diese Auflistung durch mehrere Threads zuzulassen, müssen Sie eine eigene Synchronisierung implementieren.

Standardimplementierungen der Auflistungen im System.Collections.Generic-Namespace werden nicht synchronisiert.

Hinweise für Ausführende

Die Implementierung dieser Schnittstelle erfordert die Implementierung der nichtgenerischen IEnumerator Schnittstelle. Die MoveNext() Methoden und Reset() sind nicht von abhängig Tund werden nur von der nichtgenerischen Schnittstelle angezeigt. Die Current Eigenschaft wird auf beiden Schnittstellen angezeigt und weist unterschiedliche Rückgabetypen auf. Implementieren Sie die nichtgenerische Current Eigenschaft als explizite Schnittstellenimplementierung. Dadurch kann jeder Consumer der nichtgenerischen Schnittstelle die generische Schnittstelle nutzen.

Implementiert außerdem , was erfordert, IEnumerator<T>IDisposabledass Sie die Dispose() -Methode implementieren. Dadurch können Sie Datenbankverbindungen oder Dateihandles oder ähnliche Vorgänge schließen, wenn Sie andere Ressourcen verwenden. Wenn keine zusätzlichen Ressourcen zur Verfügung stehen, stellen Sie eine leere Dispose() Implementierung bereit.

Eigenschaften

Current

Ruft das Element in der Auflistung an der aktuellen Position des Enumerators ab.

Methoden

Dispose()

Führt anwendungsspezifische Aufgaben durch, die mit der Freigabe, der Zurückgabe oder dem Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen.

(Geerbt von IDisposable)
MoveNext()

Setzt den Enumerator auf das nächste Element der Auflistung.

(Geerbt von IEnumerator)
Reset()

Setzt den Enumerator auf seine anfängliche Position vor dem ersten Element in der Auflistung.

(Geerbt von IEnumerator)

Gilt für:

Weitere Informationen