IEnumerator IEnumerator IEnumerator IEnumerator Interface

Definição

Dá suporte a uma iteração simples em uma coleção não 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

Exemplos

O exemplo de código a seguir demonstra a implementação do IEnumerable e IEnumerator interfaces para uma coleção personalizada.The following code example demonstrates the implementation of the IEnumerable and IEnumerator interfaces for a custom collection. Neste exemplo, os membros dessas interfaces não são chamados explicitamente, mas eles são implementados para dar suporte o uso de foreach (for each no Visual Basic) para iterar pela coleção.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
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

Comentários

IEnumerator é a interface base para todos os enumeradores não genérico.IEnumerator is the base interface for all non-generic enumerators. Seu equivalente genérico é o System.Collections.Generic.IEnumerator<T> interface.Its generic equivalent is the System.Collections.Generic.IEnumerator<T> interface.

O foreach instrução da linguagem c# (for each no Visual Basic) oculta a complexidade dos enumeradores.The foreach statement of the C# language (for each in Visual Basic) hides the complexity of the enumerators. Portanto, o uso foreach é recomendado em vez de manipular diretamente o enumerador.Therefore, using foreach is recommended instead of directly manipulating the enumerator.

Os enumeradores podem ser usados para ler os dados na coleção, mas não podem ser usados para modificar a coleção subjacente.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

O Reset método é fornecido para interoperabilidade COM e não precisa ser totalmente implementado; em vez disso, o implementador pode lançar um NotSupportedException.The Reset method is provided for COM interoperability and does not need to be fully implemented; instead, the implementer can throw a NotSupportedException.

Inicialmente, o enumerador é posicionado antes do primeiro elemento da coleção.Initially, the enumerator is positioned before the first element in the collection. Você deve chamar o MoveNext método para avançar o enumerador para o primeiro elemento da coleção antes de ler o valor de Current; caso contrário, Current é 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 retorna o mesmo objeto até MoveNext ou Reset ser chamado.Current returns the same object until either MoveNext or Reset is called. MoveNext define Current como o próximo elemento.MoveNext sets Current to the next element.

Caso MoveNext passe o final da coleção, o enumerador é posicionado após o último elemento na coleção e MoveNext retorna 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 o enumerador está nessa posição, as chamadas subsequentes para MoveNext também retornam false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Caso a última chamada para MoveNext tenha retornado false, Current está indefinido.If the last call to MoveNext returned false, Current is undefined.

Para definir Current para o primeiro elemento da coleção novamente, você pode chamar Reset, se ele for implementado, seguido por MoveNext.To set Current to the first element of the collection again, you can call Reset, if it's implemented, followed by MoveNext. Se Reset não é implementada, você deve criar uma nova instância de enumerador para retornar para o primeiro elemento da coleção.If Reset is not implemented, you must create a new enumerator instance to return to the first element of the collection.

Se forem feitas alterações na coleção, como adicionar, modificar ou excluir elementos, o comportamento do enumerador é indefinido.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

O enumerador não tem acesso exclusivo à coleção; por isso, a enumeração por meio de uma coleção não é um procedimento thread-safe intrínseco.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Mesmo quando uma coleção está sincronizada, outros threads ainda podem modificar a coleção, o que faz o enumerador lançar uma exceção.Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. Para garantir thread-safe durante a enumeração, é possível bloquear a coleção durante toda a enumeração ou verificar as exceções resultantes das alterações feitas por outros threads.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.

Propriedades

Current Current Current Current

Obtém o elemento na coleção na posição atual do enumerador.Gets the element in the collection at the current position of the enumerator.

Métodos

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

Avança o enumerador para o próximo elemento da coleção.Advances the enumerator to the next element of the collection.

Reset() Reset() Reset() Reset()

Define o enumerador com sua posição inicial, que é antes do primeiro elemento da coleção.Sets the enumerator to its initial position, which is before the first element in the collection.

Aplica-se a

Veja também