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

Definición

Admite una iteración simple en una colección genérica.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

Parámetros de tipo

T

Tipo de los objetos que se van a enumerar.The type of objects to enumerate.

Derivado
Implementaciones

Ejemplos

En el ejemplo siguiente se muestra una implementación IEnumerator<T> de la interfaz para una clase de colección de objetos personalizados.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. El objeto personalizado es una instancia del tipo Boxy la clase de colección es. BoxCollectionThe custom object is an instance of the type Box, and the collection class is BoxCollection. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado ICollection<T> para la interfaz.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

Comentarios

IEnumerator<T>es la interfaz base para todos los enumeradores genéricos.IEnumerator<T> is the base interface for all generic enumerators.

La foreach instrucción del C# lenguajefor each (en C++, For Each en Visual Basic) oculta la complejidad de los enumeradores.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Por lo tanto, se recomienda el uso de foreach, en lugar de manipular directamente el enumerador.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Los enumeradores pueden usarse para leer los datos de la colección, pero no para modificar la colección subyacente.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

En principio, el enumerador se coloca antes del primer elemento de la colección.Initially, the enumerator is positioned before the first element in the collection. En esta posición, el valor de propiedad Current está sin definir.At this position, Current is undefined. Por lo tanto, debe llamar a MoveNext para adelantar el enumerador hasta el primer elemento de la colección antes de leer el valor 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 devuelve el mismo objeto hasta que se llama a MoveNext.Current returns the same object until MoveNext is called. MoveNext establece Current en el siguiente elemento.MoveNext sets Current to the next element.

Si MoveNext pasa el final de la colección, el enumerador se coloca detrás del último elemento de la colección MoveNext y falsedevuelve.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Cuando el enumerador está en esta posición, las llamadas MoveNext subsiguientes a también devuelven false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Si la última llamada a MoveNext devolvió Current false, no está definida.If the last call to MoveNext returned false, Current is undefined. No puede volver a establecer la propiedad Current en el primer elemento de la colección, sino que debe crear una nueva instancia del enumerador.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

El Reset método se proporciona para la interoperabilidad com.The Reset method is provided for COM interoperability. No es necesario que se implemente necesariamente; en su lugar, el implementador simplemente puede producir NotSupportedExceptionuna excepción.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Sin embargo, si decide hacer esto, debe asegurarse de que ningún llamador confía en la Reset funcionalidad.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Si se realizan cambios en la colección, como agregar, modificar o eliminar elementos, el comportamiento del enumerador es indefinido.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

El enumerador no tiene acceso exclusivo a la colección y, por tanto, la enumeración en una colección no es intrínsicamente un procedimiento seguro para subprocesos.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. A fin de garantizar la seguridad de los subprocesos, se puede bloquear la colección durante toda la enumeración.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Para permitir que varios subprocesos obtengan acceso de lectura y escritura a la colección, debe implementar su propia sincronización.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Las implementaciones predeterminadas de las colecciones del espacio de nombres System.Collections.Generic no están sincronizadas.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Notas a los implementadores

La implementación de esta interfaz requiere la implementación IEnumerator de la interfaz no genérica.Implementing this interface requires implementing the nongeneric IEnumerator interface. Los MoveNext() métodos Reset() y no dependen de Ty solo aparecen en la interfaz no genérica.The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. La Current propiedad aparece en ambas interfaces y tiene distintos tipos de valor devueltos.The Current property appears on both interfaces, and has different return types. Implemente la propiedad Current nongeneric como una implementación de interfaz explícita.Implement the nongeneric Current property as an explicit interface implementation. Esto permite que cualquier consumidor de la interfaz no genérica consuma la interfaz genérica.This allows any consumer of the nongeneric interface to consume the generic interface.

Además, IEnumerator<T> IDisposableimplementa, que requiere que se implemente el Dispose() método.In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Esto permite cerrar las conexiones de base de datos o liberar identificadores de archivo o operaciones similares al usar otros recursos.This enables you to close database connections or release file handles or similar operations when using other resources. Si no hay recursos adicionales para desechar, proporcione una implementación vacía Dispose() .If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Propiedades

Current Current Current Current

Obtiene el elemento de la colección situado en la posición actual del enumerador.Gets the element in the collection at the current position of the enumerator.

Métodos

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

Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

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

Desplaza el enumerador al siguiente elemento de la colección.Advances the enumerator to the next element of the collection.

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

Establece el enumerador en su posición inicial (antes del primer elemento de la colección).Sets the enumerator to its initial position, which is before the first element in the collection.

(Inherited from IEnumerator)

Se aplica a

Consulte también: