IEnumerator<T> Interface

Définition

Prend en charge une itération simple sur une collection générique.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

Paramètres de type

T

Type des objets à énumérer.The type of objects to enumerate.

Dérivé
Implémente

Exemples

L’exemple suivant illustre une implémentation de l' IEnumerator<T> interface pour une classe de collection d’objets personnalisés.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. L’objet personnalisé est une instance du type Boxet la classe de collection est. BoxCollectionThe custom object is an instance of the type Box, and the collection class is BoxCollection. Cet exemple de code fait partie d’un exemple plus complet fourni ICollection<T> pour l’interface.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

Remarques

IEnumerator<T>est l’interface de base pour tous les énumérateurs génériques.IEnumerator<T> is the base interface for all generic enumerators.

L' foreach instruction de la C# for eachlangue( dans C++masque la complexité des énumérateurs. For EachThe foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Il est donc recommandé d'utiliser foreach plutôt que de manipuler l'énumérateur directement.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Les énumérateurs peuvent être utilisés pour lire les données de la collection, mais ils ne permettent pas de modifier la collection sous-jacente.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Au départ, l'énumérateur est positionné avant le premier élément de la collection.Initially, the enumerator is positioned before the first element in the collection. À cette position, Current n'est pas défini.At this position, Current is undefined. Par conséquent, vous devez appeler MoveNext pour avancer l'énumérateur jusqu'au premier élément de la collection avant de lire la valeur de Current.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current retourne le même objet jusqu'à ce que MoveNext soit appelé.Current returns the same object until MoveNext is called. MoveNext affecte l'élément suivant à Current.MoveNext sets Current to the next element.

Si MoveNext passe la fin de la collection, l’énumérateur est positionné après le dernier élément de la collection et MoveNext retourne false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Lorsque l’énumérateur se trouve à cette position, les appels MoveNext suivants à falseretournent également.When the enumerator is at this position, subsequent calls to MoveNext also return false. Si le dernier appel à MoveNext Current retourné falseest non défini.If the last call to MoveNext returned false, Current is undefined. Vous ne pouvez pas attribuer de nouveau Current au premier élément de la collection ; vous devez créer une nouvelle instance de l’énumérateur à la place.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

La Reset méthode est fournie pour l’interopérabilité COM.The Reset method is provided for COM interoperability. Elle n’a pas nécessairement besoin d’être implémentée ; au lieu de cela, l’implémenteur peut NotSupportedExceptionsimplement lever une.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Toutefois, si vous choisissez de le faire, vous devez vous assurer qu’aucun appelant ne dépend de la Reset fonctionnalité.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Si des modifications sont apportées à la collection, telles que l’ajout, la modification ou la suppression d’éléments, le comportement de l’énumérateur n’est pas défini.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

Comme l’énumérateur ne dispose pas d’un accès exclusif à la collection, l’énumération d’une collection n’est pas intrinsèquement une procédure thread-safe.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Pour garantir la sécurité des threads pendant l'énumération, vous pouvez verrouiller la collection tout au long de cette opération.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Pour permettre à plusieurs threads d’accéder en lecture et en écriture à la collection, vous devez implémenter votre propre synchronisation.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Les implémentations par défaut de collections dans l’espace de noms System.Collections.Generic ne sont pas synchronisées.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Notes pour les responsables de l’implémentation

L’implémentation de cette interface requiert l’implémentation IEnumerator de l’interface non générique.Implementing this interface requires implementing the nongeneric IEnumerator interface. Les MoveNext() méthodes Reset() et ne dépendent pas de T, et apparaissent uniquement sur l’interface non générique.The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. La Current propriété apparaît sur les deux interfaces et a des types de retour différents.The Current property appears on both interfaces, and has different return types. Implémentez la propriété Current non générique en tant qu’implémentation d’interface explicite.Implement the nongeneric Current property as an explicit interface implementation. Cela permet à n’importe quel consommateur de l’interface non générique d’utiliser l’interface générique.This allows any consumer of the nongeneric interface to consume the generic interface.

En outre, IEnumerator<T> IDisposableimplémente, ce qui vous oblige à implémenter la Dispose() méthode.In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Cela vous permet de fermer des connexions de base de données ou de libérer des handles de fichiers ou des opérations similaires lors de l’utilisation d’autres ressources.This enables you to close database connections or release file handles or similar operations when using other resources. S’il n’y a aucune ressource supplémentaire à supprimer, fournissez Dispose() une implémentation vide.If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Propriétés

Current

Obtient l’élément de la collection situé à la position actuelle de l’énumérateur.Gets the element in the collection at the current position of the enumerator.

Méthodes

Dispose()

Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Hérité de IDisposable)
MoveNext()

Avance l’énumérateur à l’élément suivant de la collection.Advances the enumerator to the next element of the collection.

(Hérité de IEnumerator)
Reset()

Rétablit l'énumérateur à sa position initiale, qui précède le premier élément de la collection.Sets the enumerator to its initial position, which is before the first element in the collection.

(Hérité de IEnumerator)

S’applique à

Voir aussi