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

定義

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

型パラメーター

T

列挙するオブジェクトの型。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;
        }
        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

注釈

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

foreach C# 言語のステートメント (for each C++ では、 For Each Visual basic) 列挙子の複雑さが隠されています。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.

最初に、列挙子はコレクション内の 1 番目の要素の前に位置付けられます。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列挙子、コレクションの末尾がコレクション内の最後の要素の後に配置されているパスとMoveNext返しますfalseします。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返されるfalseCurrentが定義されていません。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.

プロパティ

Current Current Current Current

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

メソッド

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

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

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

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

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

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

(Inherited from IEnumerator)

適用対象

こちらもご覧ください