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

Definição

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

O tipo de objetos a serem enumerados.The type of objects to enumerate.

Derivado
Implementações

Exemplos

O exemplo a seguir mostra uma implementação do IEnumerator<T> interface para uma classe de coleção de objetos personalizados.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. O objeto personalizado é uma instância do tipo Box, e a classe de coleção é BoxCollection.The custom object is an instance of the type Box, and the collection class is BoxCollection. Este exemplo de código é parte de um exemplo maior fornecido para o ICollection<T> 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

Comentários

IEnumerator<T> é a interface base para todos os enumeradores genéricos.IEnumerator<T> is the base interface for all generic enumerators.

A instrução foreach da linguagem C# (for each no C++, For Each no Visual Basic) oculta a complexidade dos enumeradores.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Portanto, o uso de 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.

Inicialmente, o enumerador é posicionado antes do primeiro elemento da coleção.Initially, the enumerator is positioned before the first element in the collection. Nesta posição, Current está indefinido.At this position, Current is undefined. Por isso, você deve chamar MoveNext para avançar o enumerador até o primeiro elemento da coleção antes de ler o 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 Retorna o mesmo objeto até MoveNext é chamado.Current returns the same object until MoveNext 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. Não é possível definir Current como o primeiro elemento da coleção novamente; você deve criar uma nova instância de enumerador em vez disso.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

O Reset método é fornecido para interoperabilidade COM.The Reset method is provided for COM interoperability. Ele não precisa necessariamente ser implementadas; em vez disso, o implementador pode simplesmente lançar um NotSupportedException.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. No entanto, se você optar por fazer isso, assegure-se de não depender de nenhum chamador o Reset funcionalidade.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

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. Para garantir acesso thread-safe durante a enumeração, é possível bloquear a coleção durante toda a enumeração.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Para permitir que a coleção seja acessada por vários threads para leitura e gravação, você deve implementar sua própria sincronização.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

As implementações padrão de coleções no namespace System.Collections.Generic não são sincronizadas.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Notas aos Implementadores

Implementar essa interface requer a implementação não genérica IEnumerator interface.Implementing this interface requires implementing the nongeneric IEnumerator interface. O MoveNext() e Reset() métodos não dependem de Te só aparecem na interface não genérica.The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. O Current propriedade aparece em ambas as interfaces e tem diferentes tipos de retorno.The Current property appears on both interfaces, and has different return types. Implementar não genérica Current a propriedade como uma implementação de interface explícita.Implement the nongeneric Current property as an explicit interface implementation. Isso permite que qualquer consumidor da interface não genérica consumir a interface genérica.This allows any consumer of the nongeneric interface to consume the generic interface.

Além disso, IEnumerator<T> implementa IDisposable, que exige que você implemente o Dispose() método.In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Isso permite que você fechar conexões de banco de dados ou liberar identificadores de arquivos ou operações semelhantes ao usar outros recursos.This enables you to close database connections or release file handles or similar operations when using other resources. Se não existem recursos adicionais para descarte, forneça um vazio Dispose() implementação.If there are no additional resources to dispose of, provide an empty Dispose() implementation.

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

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

Realiza tarefas definidas pelo aplicativo associadas à liberação ou à redefinição de recursos não gerenciados.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from IDisposable)
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.

(Inherited from IEnumerator)
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.

(Inherited from IEnumerator)

Aplica-se a

Veja também