IEnumerator<T> IEnumerator<T> IEnumerator<T> IEnumerator<T> Interface

Definizione

Supporta una iterazione semplice in una raccolta generica.Supports a simple iteration over a generic collection.

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

Parametri di tipo

T

Tipo degli oggetti da enumerare.The type of objects to enumerate.

Derivato
Implementazioni

Esempi

Nell'esempio seguente viene illustrata un'implementazione del IEnumerator<T> interfaccia per una classe di raccolta di oggetti personalizzati.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. L'oggetto personalizzato è un'istanza del tipo Box, e la classe di raccolta è BoxCollection.The custom object is an instance of the type Box, and the collection class is BoxCollection. Questo esempio di codice è parte di un esempio più esaustivo disponibile per il ICollection<T> interfaccia.This code example is part of a larger example provided for the ICollection<T> interface.


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

Commenti

IEnumerator<T> è l'interfaccia di base per tutti gli enumeratori generici.IEnumerator<T> is the base interface for all generic enumerators.

Il foreach istruzione del linguaggio c# (for each in C++, For Each in Visual Basic) nasconde la complessità degli enumeratori.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Pertanto, si consiglia l'utilizzo di foreach, anziché la modifica diretta dell'enumeratore.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

È possibile utilizzare enumeratori per leggere i dati nella raccolta, ma non per modificare la raccolta sottostante.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Inizialmente l'enumeratore è posizionato davanti al primo elemento della raccolta.Initially, the enumerator is positioned before the first element in the collection. In questa posizione, la proprietà Current è indefinita.At this position, Current is undefined. Pertanto, è necessario chiamare il metodo MoveNext per spostare in avanti l'enumeratore, in corrispondenza del primo elemento della raccolta, prima di leggere il valore di Current.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

La proprietà Current restituisce lo stesso oggetto finché non viene chiamato il metodo MoveNext.Current returns the same object until MoveNext is called. MoveNext imposta Current sull'elemento successivo.MoveNext sets Current to the next element.

Se MoveNext raggiunge la fine della raccolta, l'enumeratore è posizionato dopo l'ultimo elemento nella raccolta e MoveNext restituisce false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Quando l'enumeratore si trova in questa posizione, le chiamate successive a MoveNext restituire anche false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Se l'ultima chiamata a MoveNext restituite false, Current è definito.If the last call to MoveNext returned false, Current is undefined. Non è possibile impostare nuovamente la proprietà Current sul primo elemento della raccolta; è necessario creare una nuova istanza di enumeratore.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Il Reset metodo è fornito per l'interoperabilità COM.The Reset method is provided for COM interoperability. Non è necessario implementare; al contrario, l'implementatore può semplicemente generare un NotSupportedException.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Tuttavia, se si sceglie di eseguire questa operazione, assicurarsi che nessun chiamante dipende il Reset funzionalità.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Se vengono apportate modifiche alla raccolta, ad esempio aggiungendo, modificando o eliminando elementi, non è definito il comportamento dell'enumeratore.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

L'enumeratore non dispone di accesso esclusivo alla raccolta. L'enumerazione di una raccolta non è quindi una procedura thread-safe.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Per assicurare la protezione del thread durante l'enumerazione, è possibile bloccare la raccolta durante l'intera enumerazione.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Per consentire l'accesso alla raccolta in lettura e scrittura da parte di più thread, è necessario implementare la propria sincronizzazione.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Le implementazioni predefinite di raccolte nello spazio dei nomi System.Collections.Generic non sono sincronizzate.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Note per gli implementatori

Implementazione di questa interfaccia richiede l'implementazione non generica IEnumerator interfaccia.Implementing this interface requires implementing the nongeneric IEnumerator interface. Il MoveNext() e Reset() metodi non dipendono Te vengono visualizzati solo nell'interfaccia non generica.The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. Il Current proprietà viene visualizzato in entrambe le interfacce e può restituire tipi diversi.The Current property appears on both interfaces, and has different return types. Implementare il metodo non generico Current proprietà come un'implementazione esplicita dell'interfaccia.Implement the nongeneric Current property as an explicit interface implementation. In questo modo qualsiasi consumer dell'interfaccia non generica utilizzare l'interfaccia generica.This allows any consumer of the nongeneric interface to consume the generic interface.

Inoltre IEnumerator<T> implementi IDisposable, che richiede di implementare il Dispose() (metodo).In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Ciò consente di chiudere le connessioni al database o rilasciare gli handle di file o di operazioni simili quando si usa altre risorse.This enables you to close database connections or release file handles or similar operations when using other resources. Se non sono presenti risorse aggiuntive per eliminarli, fornire un oggetto vuoto Dispose() implementazione.If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Proprietà

Current Current Current Current

Ottiene l'elemento della raccolta in corrispondenza della posizione corrente dell'enumeratore.Gets the element in the collection at the current position of the enumerator.

Metodi

Dispose() Dispose() Dispose() Dispose()

Esegue attività definite dall'applicazione, come rilasciare o reimpostare risorse non gestite.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)
MoveNext() MoveNext() MoveNext() MoveNext()

Sposta l'enumeratore all'elemento successivo della raccolta.Advances the enumerator to the next element of the collection.

(Inherited from IEnumerator)
Reset() Reset() Reset() Reset()

Imposta l'enumeratore sulla propria posizione iniziale, ovvero prima del primo elemento nella raccolta.Sets the enumerator to its initial position, which is before the first element in the collection.

(Inherited from IEnumerator)

Si applica a

Vedi anche