Udostępnij za pośrednictwem

IEnumerable Interfejs

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Collections
Zestaw:
System.Runtime.dll
Zestaw:
mscorlib.dll
Zestaw:
netstandard.dll

Uwidacznia moduł wyliczający, który obsługuje prostą iterację w kolekcji innej niż ogólna.

public interface class IEnumerable
public interface IEnumerable
[System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")]
public interface IEnumerable
[System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")]
[System.Runtime.InteropServices.ComVisible(true)]
public interface IEnumerable
type IEnumerable = interface
[<System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")>]
type IEnumerable = interface
[<System.Runtime.InteropServices.Guid("496B0ABE-CDEE-11d3-88E8-00902754C43A")>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type IEnumerable = interface
Public Interface IEnumerable
Pochodne
Atrybuty
GuidAttribute ComVisibleAttribute

Przykłady

W poniższym przykładzie kodu przedstawiono najlepsze rozwiązanie dotyczące iterowania kolekcji niestandardowej przez zaimplementowanie interfejsów IEnumerable i IEnumerator. W tym przykładzie elementy członkowskie tych interfejsów nie są jawnie wywoływane, ale są implementowane w celu obsługi korzystania z foreach (For Each w Visual Basic) w celu iteracji w kolekcji. Ten przykład to kompletna aplikacja konsolowa. Aby skompilować aplikację języka Visual Basic, zmień obiektu uruchamiania na Główne na stronie właściwości projektu.

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

Uwagi

IEnumerable jest interfejsem podstawowym dla wszystkich kolekcji innych niż ogólne, które można wyliczyć. Aby uzyskać ogólną wersję tego interfejsu, zobacz System.Collections.Generic.IEnumerable<T>. IEnumerable zawiera jedną metodę GetEnumerator, która zwraca IEnumerator. IEnumerator umożliwia iterowanie kolekcji przez uwidacznianie właściwości Current oraz metod MoveNext i Reset.

Najlepszym rozwiązaniem jest zaimplementowanie IEnumerable i IEnumerator w klasach kolekcji w celu włączenia składni foreach (For Each w języku Visual Basic), jednak implementacja IEnumerable nie jest wymagana. Jeśli kolekcja nie implementuje IEnumerable, należy nadal postępować zgodnie ze wzorcem iteratora, aby obsługiwać tę składnię, podając metodę GetEnumerator zwracającą interfejs, klasę lub strukturę. W przypadku korzystania z języka Visual Basic należy podać implementację IEnumerator, która jest zwracana przez GetEnumerator. Podczas opracowywania za pomocą języka C# należy podać klasę zawierającą właściwość Current oraz metody MoveNext i Reset zgodnie z opisem w IEnumerator, ale klasa nie musi implementować IEnumerator.

Metody

GetEnumerator()

Zwraca moduł wyliczający, który iteruje za pośrednictwem kolekcji.

Metody rozszerzania

Cast<TResult>(IEnumerable)

Rzutuje elementy IEnumerable do określonego typu.
OfType<TResult>(IEnumerable)

Filtruje elementy IEnumerable na podstawie określonego typu.
AsParallel(IEnumerable)

Umożliwia równoległość zapytania.
AsQueryable(IEnumerable)

Konwertuje IEnumerable na IQueryable.

Dotyczy

Zobacz też