IEnumerator<T> インターフェイス


ジェネリック コレクションに対する単純な反復処理をサポートします。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



列挙するオブジェクトの型。The type of objects to enumerate.

この型パラメーターは共変です。 つまり、指定した型、または強い派生型のいずれかを使用することができます。 共変性および反変性の詳細については、「ジェネリックの共変性と反変性」をご覧ください。

次の例は、カスタムオブジェクトのコレクションクラスの IEnumerator<T> インターフェイスの実装を示しています。The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. カスタムオブジェクトは Box型のインスタンスであり、コレクションクラスは BoxCollectionです。The custom object is an instance of the type Box, and the collection class is BoxCollection. このコード例は、ICollection<T> インターフェイス用に用意されている、より大きな例の一部です。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;
            // 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)
        _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
            '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

            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

            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
            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


IEnumerator<T> は、すべての汎用列挙子の基本インターフェイスです。IEnumerator<T> is the base interface for all generic enumerators.

C# 言語の foreach ステートメント (C++ では for each、Visual Basic では For Each) では、列挙子の複雑さが隠されています。The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. したがって、列挙子を直接操作するのではなく、foreach を使用することをお勧めします。Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

列挙子を使用すると、コレクション内のデータを読み取ることができますが、基になるコレクションを変更することはできません。Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

最初、列挙子はコレクションの先頭の要素の前に位置付けられます。Initially, the enumerator is positioned before the first element in the collection. この位置では、Current は未定義です。At this position, Current is undefined. そのため、MoveNext の値を読み取る前に、Current を呼び出して列挙子をコレクションの最初の要素に進める必要があります。Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current は、MoveNext が呼び出されるまでは同じオブジェクトを返します。Current returns the same object until MoveNext is called. MoveNext は、Current を次の要素に設定します。MoveNext sets Current to the next element.

MoveNext がコレクションの末尾を通過した場合、列挙子がコレクション内の最後の要素の後に配置され、MoveNextfalse を返します。If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. 列挙子がこの位置にある場合、後続の MoveNext 呼び出しも false を返します。When the enumerator is at this position, subsequent calls to MoveNext also return false. MoveNext の最後の呼び出しが falseを返した場合、Current は定義されていません。If the last call to MoveNext returned false, Current is undefined. Current を、再度、コレクションの最初の要素に設定することはできません。列挙子の新しいインスタンスを作成する必要があります。You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Reset メソッドは、COM 相互運用性のために用意されています。The Reset method is provided for COM interoperability. 必ずしも実装する必要はありません。代わりに、実装者は単に NotSupportedExceptionをスローすることができます。It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. ただし、これを選択した場合は、呼び出し元が Reset 機能に依存していないことを確認する必要があります。However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

要素の追加、変更、削除などの変更がコレクションに対して行われた場合、列挙子の動作は未定義になります。If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

列挙子はコレクションに排他アクセスできないため、コレクションの列挙処理は本質的にスレッド セーフな処理ではありません。The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. 列挙処理でスレッド セーフを確保するために、列挙処理が終わるまでコレクションをロックできます。To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. コレクションに対し複数のスレッドがアクセスして読み取りや書き込みを行うことができるようにするには、独自に同期化を実装する必要があります。To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

System.Collections.Generic 名前空間のコレクションの既定の実装は同期されません。Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

注意 (実装者)

このインターフェイスを実装するには、非ジェネリック IEnumerator インターフェイスを実装する必要があります。Implementing this interface requires implementing the nongeneric IEnumerator interface. MoveNext() メソッドと Reset() メソッドは Tに依存せず、非ジェネリックインターフェイスにのみ表示されます。The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. Current プロパティは両方のインターフェイスに表示され、異なる戻り値の型があります。The Current property appears on both interfaces, and has different return types. 明示的なインターフェイスの実装として、非ジェネリックの Current プロパティを実装します。Implement the nongeneric Current property as an explicit interface implementation. これにより、非ジェネリックインターフェイスのすべてのコンシューマーが、ジェネリックインターフェイスを使用できるようになります。This allows any consumer of the nongeneric interface to consume the generic interface.

さらに、IEnumerator<T>IDisposableを実装するため、Dispose() メソッドを実装する必要があります。In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. これにより、他のリソースを使用する場合に、データベース接続を終了したり、ファイルハンドルを解放したり、同様の操作を実行したりできます。This enables you to close database connections or release file handles or similar operations when using other resources. 破棄するリソースが追加されていない場合は、空の Dispose() 実装を指定します。If there are no additional resources to dispose of, provide an empty Dispose() implementation.



列挙子の現在位置にあるコレクション内の要素を取得します。Gets the element in the collection at the current position of the enumerator.



アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(継承元 IDisposable)

列挙子をコレクションの次の要素に進めます。Advances the enumerator to the next element of the collection.

(継承元 IEnumerator)

列挙子を初期位置、つまりコレクションの最初の要素の前に設定します。Sets the enumerator to its initial position, which is before the first element in the collection.

(継承元 IEnumerator)