IEnumerator IEnumerator IEnumerator IEnumerator Interface

Definición

Admite una iteración simple a través de una colección no genérica.Supports a simple iteration over a non-generic collection.

public interface class IEnumerator
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("496B0ABF-CDEE-11d3-88E8-00902754C43A")]
public interface IEnumerator
type IEnumerator = interface
Public Interface IEnumerator
Derivado
Atributos

Ejemplos

En el ejemplo de código siguiente se muestra la IEnumerable implementación IEnumerator de las interfaces y para una colección personalizada.The following code example demonstrates the implementation of the IEnumerable and IEnumerator interfaces for a custom collection. En este ejemplo, no se llama a los miembros de estas interfaces explícitamente, pero se implementan para admitir foreach elfor each uso de (en Visual Basic) para recorrer en iteración la colección.In this example, members of these interfaces are not explicitly called, but they are implemented to support the use of foreach (for each in Visual Basic) to iterate through the collection.

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

// Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
       return (IEnumerator) GetEnumerator();
    }

    public PeopleEnum GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
    public Person[] _people;

    // Enumerators are positioned before the first element
    // until the first MoveNext() call.
    int position = -1;

    public PeopleEnum(Person[] list)
    {
        _people = list;
    }

    public bool MoveNext()
    {
        position++;
        return (position < _people.Length);
    }

    public void Reset()
    {
        position = -1;
    }

    object IEnumerator.Current
    {
        get
        {
            return Current;
        }
    }

    public Person Current
    {
        get
        {
            try
            {
                return _people[position];
            }
            catch (IndexOutOfRangeException)
            {
                throw new InvalidOperationException();
            }
        }
    }
}

class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);

    }
}

/* This code produces output similar to the following:
 *
 * John Smith
 * Jim Johnson
 * Sue Rabon
 *
 */
Imports System.Collections

' Simple business object.
Public Class Person

    Public Sub New(ByVal fName As String, ByVal lName As String)
        Me.firstName = fName
        Me.lastName = lName
    End Sub


    Public firstName As String
    Public lastName As String
End Class

' Collection of Person objects, which implements IEnumerable so that
' it can be used with ForEach syntax.
Public Class People
    Implements IEnumerable

    Private _people() As Person

    Public Sub New(ByVal pArray() As Person)
        _people = New Person(pArray.Length - 1) {}

        Dim i As Integer
        For i = 0 To pArray.Length - 1
            _people(i) = pArray(i)
        Next i
    End Sub

    ' Implementation of GetEnumerator.
    Public Function GetEnumerator() As IEnumerator _
      Implements IEnumerable.GetEnumerator

        Return New PeopleEnum(_people)
    End Function

End Class

' When you implement IEnumerable, you must also implement IEnumerator.
Public Class PeopleEnum
    Implements IEnumerator

    Public _people() As Person

    ' Enumerators are positioned before the first element
    ' until the first MoveNext() call.
    Dim position As Integer = -1

    Public Sub New(ByVal list() As Person)
        _people = list
    End Sub

    Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
        position = position + 1
        Return (position < _people.Length)
    End Function

    Public Sub Reset() Implements IEnumerator.Reset
        position = -1
    End Sub

    Public ReadOnly Property Current() As Object Implements IEnumerator.Current
        Get
            Try
                Return _people(position)
            Catch ex As IndexOutOfRangeException
                Throw New InvalidOperationException()
            End Try
        End Get
    End Property
End Class

Class App
    Shared Sub Main()
        Dim peopleArray() As Person = { _
            New Person("John", "Smith"), _
            New Person("Jim", "Johnson"), _
            New Person("Sue", "Rabon")}

        Dim peopleList As New People(peopleArray)
        Dim p As Person
        For Each p In peopleList
            Console.WriteLine(p.firstName + " " + p.lastName)
        Next

    End Sub
End Class

' This code produces output similar to the following:
' 
' John Smith
' Jim Johnson
' Sue Rabon

Comentarios

IEnumeratores la interfaz base para todos los enumeradores no genéricos.IEnumerator is the base interface for all non-generic enumerators. Su equivalente genérico es la System.Collections.Generic.IEnumerator<T> interfaz.Its generic equivalent is the System.Collections.Generic.IEnumerator<T> interface.

La instrucción foreach del lenguaje C# (for each en Visual Basic) oculta la complejidad de los enumeradores.The foreach statement of the C# language (for each in Visual Basic) hides the complexity of the enumerators. Por lo tanto foreach , se recomienda utilizar 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.

El Reset método se proporciona para la interoperabilidad com y no es necesario que esté totalmente implementado; en su lugar, el implementador puede producir una NotSupportedExceptionexcepción.The Reset method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a NotSupportedException.

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. Debe llamar MoveNext al método para avanzar el enumerador hasta el primer elemento de la colección antes de leer el valor Currentde; de Current lo contrario, es indefinido.You must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current; otherwise, Current is undefined.

Current devuelve el mismo objeto hasta que se llama a MoveNext o a Reset.Current returns the same object until either MoveNext or Reset 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.

Para volver Current a establecer en el primer elemento de la colección, puede llamar Reseta, si está implementado, seguido MoveNextde.To set Current to the first element of the collection again, you can call Reset, if it's implemented, followed by MoveNext. Si Reset no está implementado, debe crear una nueva instancia de enumerador para volver al primer elemento de la colección.If Reset is not implemented, you must create a new enumerator instance to return to the first element of the collection.

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. Incluso cuando una colección está sincronizada, otros subprocesos todavía pueden modificarla, lo que hace que el enumerador produzca una excepción.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Con el fin de garantizar la seguridad para la ejecución de subprocesos durante la enumeración, se puede bloquear la colección durante toda la enumeración o detectar las excepciones resultantes de los cambios realizados por otros subprocesos.To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

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

MoveNext() MoveNext() MoveNext() MoveNext()

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

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.

Se aplica a

Consulte también: