方法 : foreach を使用してコレクション クラスにアクセスする (C# プログラミング ガイド)

  • [アーティクル]

更新 : 2007 年 11 月

次のコード例では、foreach と共に使用できる非ジェネリック コレクション クラスの記述方法を示します。クラスは、C ランタイム関数の strtok_s と同様に、文字列をトークン化します。

9yb8xew9.alert_note(ja-jp,VS.90).gifメモ :

この例では、ジェネリック コレクション クラスを使用できない場合にのみ推奨される方法を示します。ジェネリックは、Version 2.0 およびそれ以降の C# 言語と .NET Framework でサポートされています。IEnumerable<T> をサポートする (つまり、このトピックで後述する問題を回避する) タイプ セーフなジェネリック コレクション クラスを実装する方法の例については、「方法 : ジェネリック リストの反復子ブロックを作成する (C# プログラミング ガイド)」を参照してください。

次の例では、Tokens で、区切り記号の ' ' と '-' を使って "This is a sample sentence." という文をトークンに分割し、foreach ステートメントによってこれらのトークンを列挙します。

Tokens f = new Tokens("This is a sample sentence.", new char[] {' ','-'});

foreach (string item in f)
{
    System.Console.WriteLine(item);
}

内部的には、Tokens は IEnumerator と IEnumerable を実装する配列を使用しています。配列の列挙メソッドを使用する方法もありますが、この例では適切ではありません。

C# では、foreach と互換性を保つために、コレクション クラスを IEnumerable と IEnumerator から継承することは必ずしも必須ではありません。必須の GetEnumerator、MoveNext、Reset、および Current の各メンバがクラスに含まれている限り、コレクション クラスで foreach を使用できます。インターフェイスを省略すると、Current の戻り値の型を Object よりも明確に定義できるので、結果としてタイプ セーフになります。

たとえば、このトピックで前述したコードを基にして、次の行を変更します。

// No longer inherits from IEnumerable:
public class Tokens  
// Doesn't return an IEnumerator:
public TokenEnumerator GetEnumerator()  
// No longer inherits from IEnumerator:
public class TokenEnumerator  
// Type-safe: returns string, not object:
public string Current

この変更により、Current によって文字列が返されるため、foreach ステートメントで非互換型が使用されたことをコンパイラが検出できるようになります。

// Error: cannot convert string to int:
foreach (int item in f)

ただし、IEnumerable と IEnumerator を省略すると、コレクション クラスを他の共通言語ランタイム互換言語の foreach ステートメント (または同等のステートメント) と相互運用できなくなるので注意が必要です。

一方、IEnumerable と IEnumerator の継承、および明示的なインターフェイスの実装を併用することにより、C# のタイプ セーフ性と、他の共通言語ランタイム互換言語との相互運用性の 2 つの利点を享受できます。次に例を示します。

使用例

using System.Collections;

// Declare the Tokens class:
public class Tokens : IEnumerable
{
    private string[] elements;

    Tokens(string source, char[] delimiters)
    {
        // Parse the string into tokens:
        elements = source.Split(delimiters);
    }

    // IEnumerable Interface Implementation:
    //   Declaration of the GetEnumerator() method 
    //   required by IEnumerable
    public IEnumerator GetEnumerator()
    {
        return new TokenEnumerator(this);
    }


    // Inner class implements IEnumerator interface:
    private class TokenEnumerator : IEnumerator
    {
        private int position = -1;
        private Tokens t;

        public TokenEnumerator(Tokens t)
        {
            this.t = t;
        }

        // Declare the MoveNext method required by IEnumerator:
        public bool MoveNext()
        {
            if (position < t.elements.Length - 1)
            {
                position++;
                return true;
            }
            else
            {
                return false;
            }
        }

        // Declare the Reset method required by IEnumerator:
        public void Reset()
        {
            position = -1;
        }

        // Declare the Current property required by IEnumerator:
        public object Current
        {
            get
            {
                return t.elements[position];
            }
        }
    }


    // Test Tokens, TokenEnumerator
    static void Main()
    {
        // Testing Tokens by breaking the string into tokens:
        Tokens f = new Tokens("This is a sample sentence.", new char[] {' ','-'});

        foreach (string item in f)
        {
            System.Console.WriteLine(item);
        }
    }
}
/* Output:
    This
    is
    a
    sample
    sentence.  
*/

参照

概念

C# プログラミング ガイド

参照

配列 (C# プログラミング ガイド)

コレクション クラス (C# プログラミング ガイド)

System.Collections.Generic

その他の技術情報

C# リファレンス