IEnumerator<T> Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Unterstützt eine einfache Iteration über eine generische Auflistung.
generic <typename T>
public interface class IEnumerator : IDisposable, System::Collections::IEnumeratorpublic interface IEnumerator<out T> : IDisposable, System.Collections.IEnumeratorpublic interface IEnumerator<T> : IDisposable, System.Collections.IEnumeratortype IEnumerator<'T> = interface
interface IEnumerator
interface IDisposabletype IEnumerator<'T> = interface
interface IDisposable
interface IEnumeratorPublic Interface IEnumerator(Of Out T)
Implements IDisposable, IEnumeratorPublic Interface IEnumerator(Of T)
Implements IDisposable, IEnumeratorTypparameter
- T
Der Typ der objekte, die aufgezählt werden sollen.
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
Beispiele
Das folgende Beispiel zeigt eine Implementierung der IEnumerator<T> Schnittstelle für eine Auflistungsklasse von benutzerdefinierten Objekten. Das benutzerdefinierte Objekt ist eine Instanz des Typs Box, und die Auflistungsklasse wird BoxCollection. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die ICollection<T>-Schnittstelle bereitgestellt wird.
// 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 Enumerationen.
Die foreach-Anweisung der C#-Sprache (for each in C++, For Each in Visual Basic) blendet die Komplexität der Enumerationen aus. Daher wird die Verwendung von foreach empfohlen, anstatt den Enumerator direkt zu bearbeiten.
Enumeratoren können verwendet werden, um die Daten in der Auflistung zu lesen, aber sie können nicht zum Ändern der zugrunde liegenden Auflistung verwendet werden.
Zunächst wird der Enumerator vor dem ersten Element in der Auflistung positioniert. An dieser Position ist Current nicht definiert. Daher müssen Sie MoveNext aufrufen, um den Enumerator zum ersten Element der Auflistung zu wechseln, bevor Sie den Wert von Currentlesen.
Current gibt 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 nach dem letzten Element in der Auflistung positioniert und MoveNext gibt falsezurück. Wenn sich der Enumerator an dieser Position befindet, geben nachfolgende Aufrufe von MoveNext auch falsezurück. Wenn der letzte Aufruf von MoveNextfalsezurückgegeben wurde, ist Current nicht definiert. Sie können Current nicht erneut auf das erste Element der Auflistung festlegen; Sie müssen stattdessen eine neue Enumerationsinstanz erstellen.
Die Reset-Methode wird für die COM-Interoperabilität bereitgestellt. Es muss nicht unbedingt umgesetzt werden; Stattdessen kann der Implementierer einfach eine 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. Hinzufügen, Ändern oder Löschen von Elementen, ist das Verhalten des Enumerators nicht definiert.
Der Enumerator hat keinen exklusiven Zugriff auf die Sammlung; Daher ist das Aufzählen durch eine Sammlung intrinsisch keine threadsichere Prozedur. Um die Threadsicherheit während der Enumeration zu gewährleisten, können Sie die Sammlung während der gesamten Enumeration sperren. Damit auf die Sammlung über mehrere Threads zum Lesen und Schreiben zugegriffen werden kann, müssen Sie eine eigene Synchronisierung implementieren.
Standardimplementierungen von Auflistungen im System.Collections.Generic-Namespace werden nicht synchronisiert.
Hinweise für Ausführende
Für die Implementierung dieser Schnittstelle ist die Implementierung der nichtgenerischen IEnumerator Schnittstelle erforderlich. Die methoden MoveNext() und Reset() hängen nicht von Tab und erscheinen nur auf der nichtgenerischen Schnittstelle. 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 Verbraucher der nichtgenerischen Schnittstelle die generische Schnittstelle nutzen.
Darüber hinaus implementiert IEnumerator<T>IDisposable, was erfordert, dass Sie die Dispose()-Methode implementieren. Auf diese Weise können Sie Datenbankverbindungen schließen oder Dateihandles oder ähnliche Vorgänge freigeben, 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 anwendungsdefinierte Aufgaben aus, die mit dem Freigeben, Freigeben oder Zurücksetzen nicht verwalteter Ressourcen verknüpft sind. (Geerbt von IDisposable) |
| MoveNext() |
Wechselt den Enumerator zum nächsten Element der Auflistung. (Geerbt von IEnumerator) |
| Reset() |
Legt den Enumerator auf seine Anfangsposition fest, die sich vor dem ersten Element in der Auflistung befindet. (Geerbt von IEnumerator) |
