Coleções (C# e Visual Basic)
Para muitos aplicativos, você deseja criar e gerenciar grupos de objetos relacionados. Há duas maneiras para agrupar objetos: criando matrizes de objetos e criando coleções de objetos.
Matrizes são mais úteis para criar e trabalhar com um número fixo de objetos fortemente tipados. Para obter informações sobre matrizes, consulte Matrizes no Visual Basic ou Matrizes (Guia de Programação em C#).
Coleções fornecem uma maneira mais flexível de trabalhar com grupos de objetos. Ao contrário dos arrays, o grupo de objetos com o qual você trabalha pode crescer e reduzir dinamicamente conforme as necessidades do aplicativo mudam. Para algumas coleções, você pode atribuir uma chave a qualquer objeto colocado na coleção para que você possa rapidamente recuperar o objeto usando a chave.
Uma coleção é uma classe, portanto, você deve declarar uma nova coleção antes de adicionar elementos a essa coleção.
Se sua coleção contiver elementos de apenas um tipo de dados, você pode usar uma das classes no namespace System.Collections.Generic. Uma coleção genérica impõe a segurança de tipo para que nenhum outro tipo de dados possa ser adicionado a ela. Quando você recupera um elemento de uma coleção genérica, não precisa determinar seu tipo de dados ou convertê-lo.
Dica
Para os exemplos neste tópico, inclua instruções (Visual Basic) de Importações ou diretivas (C#) de uso para namespaces System.Collections.Generic e System.Linq.
Neste tópico
Usando uma coleção simples
-
Classes System.Collections.Generic
Classes System.Collections.Concurrent
System.Collections Classes
Coleção de classes do Visual Basic
Implementando uma coleção de pares chave-valor
Usando o LINQ para acessar uma coleção
Classificando uma coleção
Definindo uma coleção personalizada
Iteradores
Usando uma coleção simples
Os exemplos desta seção usam a classe genérica de List, que permite que você trabalhe com uma lista fortemente tipada de objetos.
O exemplo a seguir cria uma lista de cadeias de caracteres e itera por meio das cadeias de caracteres usando uma instrução For Each…Next (Visual Basic) ou foreach (C#).
' Create a list of strings.
Dim salmons As New List(Of String)
salmons.Add("chinook")
salmons.Add("coho")
salmons.Add("pink")
salmons.Add("sockeye")
' Iterate through the list.
For Each salmon As String In salmons
Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye
// Create a list of strings.
var salmons = new List<string>();
salmons.Add("chinook");
salmons.Add("coho");
salmons.Add("pink");
salmons.Add("sockeye");
// Iterate through the list.
foreach (var salmon in salmons)
{
Console.Write(salmon + " ");
}
// Output: chinook coho pink sockeye
Se os conteúdos de uma coleção são conhecidos com antecedência, você pode usar um inicializador de coleção para inicializar a coleção. Para obter mais informações, consulte Inicializadores de coleção (Visual Basic) ou Inicializadores de objeto e coleção (Guia de Programação em C#).
O exemplo a seguir é igual ao exemplo anterior, exceto por um inicializador de coleção que é usado para adicionar elementos à coleção.
' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
{"chinook", "coho", "pink", "sockeye"}
For Each salmon As String In salmons
Console.Write(salmon & " ")
Next
'Output: chinook coho pink sockeye
// Create a list of strings by using a
// collection initializer.
var salmons = new List<string> { "chinook", "coho", "pink", "sockeye" };
// Iterate through the list.
foreach (var salmon in salmons)
{
Console.Write(salmon + " ");
}
// Output: chinook coho pink sockeye
É possível usar a instrução For…Next (Visual Basic) ou a instrução for (C#) em vez de uma instrução For Each para iterar em um coleção. Você realiza isso acessando os elementos da coleção através da posição de índice. O índice dos elementos inicia no 0 e termina na contagem de elementos menos 1.
O exemplo a seguir efetua iterações por meio dos elementos de uma coleção usando For…Next em vez de For Each.
Dim salmons As New List(Of String) From
{"chinook", "coho", "pink", "sockeye"}
For index = 0 To salmons.Count - 1
Console.Write(salmons(index) & " ")
Next
'Output: chinook coho pink sockeye
// Create a list of strings by using a
// collection initializer.
var salmons = new List<string> { "chinook", "coho", "pink", "sockeye" };
for (var index = 0; index < salmons.Count; index++)
{
Console.Write(salmons[index] + " ");
}
// Output: chinook coho pink sockeye
O exemplo a seguir remove um elemento da coleção especificando o objeto a ser removido.
' Create a list of strings by using a
' collection initializer.
Dim salmons As New List(Of String) From
{"chinook", "coho", "pink", "sockeye"}
' Remove an element in the list by specifying
' the object.
salmons.Remove("coho")
For Each salmon As String In salmons
Console.Write(salmon & " ")
Next
'Output: chinook pink sockeye
// Create a list of strings by using a
// collection initializer.
var salmons = new List<string> { "chinook", "coho", "pink", "sockeye" };
// Remove an element from the list by specifying
// the object.
salmons.Remove("coho");
// Iterate through the list.
foreach (var salmon in salmons)
{
Console.Write(salmon + " ");
}
// Output: chinook pink sockeye
O exemplo a seguir remove os elementos de uma lista genérica. Em vez de uma instrução For Each, uma instrução Para… Avançar (Visual Basic) ou para (C#) que executa iterações em ordem decrescente é usada. Isso ocorre porque o método RemoveAt faz com que os elementos após a remoção de um elemento tenham um valor de índice mais baixo.
Dim numbers As New List(Of Integer) From
{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}
' Remove odd numbers.
For index As Integer = numbers.Count - 1 To 0 Step -1
If numbers(index) Mod 2 = 1 Then
' Remove the element by specifying
' the zero-based index in the list.
numbers.RemoveAt(index)
End If
Next
' Iterate through the list.
' A lambda expression is placed in the ForEach method
' of the List(T) object.
numbers.ForEach(
Sub(number) Console.Write(number & " "))
' Output: 0 2 4 6 8
var numbers = new List<int> { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
// Remove odd numbers.
for (var index = numbers.Count - 1; index >= 0; index--)
{
if (numbers[index] % 2 == 1)
{
// Remove the element by specifying
// the zero-based index in the list.
numbers.RemoveAt(index);
}
}
// Iterate through the list.
// A lambda expression is placed in the ForEach method
// of the List(T) object.
numbers.ForEach(
number => Console.Write(number + " "));
// Output: 0 2 4 6 8
Para os tipos de elemento em List, você também pode definir sua própria classe. No exemplo a seguir, a classe Galaxy que é usada por List é definida no código.
Private Sub IterateThroughList()
Dim theGalaxies As New List(Of Galaxy) From
{
New Galaxy With {.Name = "Tadpole", .MegaLightYears = 400},
New Galaxy With {.Name = "Pinwheel", .MegaLightYears = 25},
New Galaxy With {.Name = "Milky Way", .MegaLightYears = 0},
New Galaxy With {.Name = "Andromeda", .MegaLightYears = 3}
}
For Each theGalaxy In theGalaxies
With theGalaxy
Console.WriteLine(.Name & " " & .MegaLightYears)
End With
Next
' Output:
' Tadpole 400
' Pinwheel 25
' Milky Way 0
' Andromeda 3
End Sub
Public Class Galaxy
Public Property Name As String
Public Property MegaLightYears As Integer
End Class
private void IterateThroughList()
{
var theGalaxies = new List<Galaxy>
{
new Galaxy() { Name="Tadpole", MegaLightYears=400},
new Galaxy() { Name="Pinwheel", MegaLightYears=25},
new Galaxy() { Name="Milky Way", MegaLightYears=0},
new Galaxy() { Name="Andromeda", MegaLightYears=3}
};
foreach (Galaxy theGalaxy in theGalaxies)
{
Console.WriteLine(theGalaxy.Name + " " + theGalaxy.MegaLightYears);
}
// Output:
// Tadpole 400
// Pinwheel 25
// Milky Way 0
// Andromeda 3
}
public class Galaxy
{
public string Name { get; set; }
public int MegaLightYears { get; set; }
}
Tipos de Coleções
Muitas coleções comuns são fornecidas pelo .NET Framework. Cada tipo de coleção foi projetado para uma finalidade específica.
Os grupos de classes de coleção a seguir são descritos nesta seção:
Classes System.Collections.Generic
Classes System.Collections.Concurrent
Classes System.Collections
Classe Collection do Visual Basic
Classes System.Collections.Generic
Você pode criar uma coleção genérica usando uma das classes no namespace System.Collections.Generic. Uma coleção genérica é útil quando cada item na coleção tem o mesmo tipo de dados. Uma coleção genérica impõe uma digitação forte, permitindo que apenas o tipo de dados desejado seja adicionado.
A tabela a seguir lista algumas das classes usadas com frequência no namespace System.Collections.Generic:
Classe |
Descrição |
Representa uma coleção de pares chave/valor que são organizadas com base na chave. |
|
Representa uma lista de objetos que podem ser acessados por índice. Fornece métodos para pesquisar, classificar e modificar listas. |
|
Representa uma coleção de objetos PEPS (primeiro a entrar, primeiro a sair). |
|
Representa uma coleção de pares chave/valor que são classificados por chave com base na implementação de IComparer associada. |
|
Representa uma coleção de objetos UEPS (último a entrar, primeiro a sair). |
Para obter informações adicionais, consulte Tipos de coleção de uso comum, Selecionando uma classe de coleção e System.Collections.Generic.
Classes System.Collections.Concurrent
No .NET Framework 4, as coleções no espaço de nome System.Collections.Concurrent fornecem operações eficientes seguras para thread para acessar itens de coleção de vários threads.
As classes no namespace System.Collections.Concurrent devem ser usadas em vez dos tipos correspondentes em System.Collections.Generic e System.Collections sempre que vários threads estiverem acessando a coleção simultaneamente. Para obter mais informações, consulte Coleções thread-safe e System.Collections.Concurrent.
Algumas classes incluídas no namespace System.Collections.Concurrent são BlockingCollection, ConcurrentDictionary, ConcurrentQueue e ConcurrentStack.
System.Collections Classes
As classes no namespace System.Collections não armazenam elementos como especificamente objetos tipados, mas como objetos do tipo Object.
Sempre que possível, você deve usar coleções genéricas no namespace de System.Collections.Generic ou namespace de System.Collections.Concurrent em vez de tipos herdados no namespace System.Collections.
A tabela a seguir lista algumas das classes usadas com frequência no namespace System.Collections:
Classe |
Descrição |
Representa uma matriz de objetos cujo tamanho é dinamicamente ampliado como necessário. |
|
Representa uma coleção de pares de chave/valor que são organizados com base no código Hash da chave. |
|
Representa uma coleção de objetos PEPS (primeiro a entrar, primeiro a sair). |
|
Representa uma coleção de objetos UEPS (último a entrar, primeiro a sair). |
O namespace System.Collections.Specialized fornece classes de coleções especializadas e fortemente tipadas, como coleções de apenas cadeias de caracteres e listas encadeadas e dicionários híbridos.
Coleção de classes do Visual Basic
É possível usar a classe Collection do Visual Basic para acessar um item da coleção usando um índice numérico ou uma chave String. Você pode adicionar itens a um objeto de coleção especificando ou não uma chave. Se você adicionar um item sem uma chave, deverá usar seu índice numérico para acessá-lo.
A classe Collection do Visual Basic armazena todos seus elementos com o tipo Object, assim você pode adicionar um item de qualquer tipo de dado. Não há proteção contra tipos de dados inapropriados sendo adicionados.
Quando você usa a classe do Visual Basic Collection, o primeiro item em uma coleção tem um índice de 1. Isso difere das classes de coleção do .NET Framework, para as quais o índice inicial é 0.
Sempre que possível, você deve usar coleções genéricas no namespace de System.Collections.Generic ou namespace de System.Collections.Concurrent em vez da classe do Visual Basic Collection.
Para obter mais informações, consulte Collection.
Implementando uma coleção de pares chave-valor
A coleção genérica Dictionary permite que você acesse elementos em uma coleção usando a chave de cada elemento. Cada adição ao dicionário consiste em um valor e em sua chave associada. A recuperação de um valor usando sua chave será rápida porque a classe Dictionary é implementada como uma tabela de hash.
O exemplo a seguir cria uma coleção Dictionary e itera por meio do dicionário usando uma instrução For Each.
Private Sub IterateThroughDictionary()
Dim elements As Dictionary(Of String, Element) = BuildDictionary()
For Each kvp As KeyValuePair(Of String, Element) In elements
Dim theElement As Element = kvp.Value
Console.WriteLine("key: " & kvp.Key)
With theElement
Console.WriteLine("values: " & .Symbol & " " &
.Name & " " & .AtomicNumber)
End With
Next
End Sub
Private Function BuildDictionary() As Dictionary(Of String, Element)
Dim elements As New Dictionary(Of String, Element)
AddToDictionary(elements, "K", "Potassium", 19)
AddToDictionary(elements, "Ca", "Calcium", 20)
AddToDictionary(elements, "Sc", "Scandium", 21)
AddToDictionary(elements, "Ti", "Titanium", 22)
Return elements
End Function
Private Sub AddToDictionary(ByVal elements As Dictionary(Of String, Element),
ByVal symbol As String, ByVal name As String, ByVal atomicNumber As Integer)
Dim theElement As New Element
theElement.Symbol = symbol
theElement.Name = name
theElement.AtomicNumber = atomicNumber
elements.Add(Key:=theElement.Symbol, value:=theElement)
End Sub
Public Class Element
Public Property Symbol As String
Public Property Name As String
Public Property AtomicNumber As Integer
End Class
private void IterateThruDictionary()
{
Dictionary<string, Element> elements = BuildDictionary();
foreach (KeyValuePair<string, Element> kvp in elements)
{
Element theElement = kvp.Value;
Console.WriteLine("key: " + kvp.Key);
Console.WriteLine("values: " + theElement.Symbol + " " +
theElement.Name + " " + theElement.AtomicNumber);
}
}
private Dictionary<string, Element> BuildDictionary()
{
var elements = new Dictionary<string, Element>();
AddToDictionary(elements, "K", "Potassium", 19);
AddToDictionary(elements, "Ca", "Calcium", 20);
AddToDictionary(elements, "Sc", "Scandium", 21);
AddToDictionary(elements, "Ti", "Titanium", 22);
return elements;
}
private void AddToDictionary(Dictionary<string, Element> elements,
string symbol, string name, int atomicNumber)
{
Element theElement = new Element();
theElement.Symbol = symbol;
theElement.Name = name;
theElement.AtomicNumber = atomicNumber;
elements.Add(key: theElement.Symbol, value: theElement);
}
public class Element
{
public string Symbol { get; set; }
public string Name { get; set; }
public int AtomicNumber { get; set; }
}
Para usar um inicializador de coleção para criar a coleção de Dictionary, você pode substituir os métodos de BuildDictionary e de AddToDictionary pelo seguinte método.
Private Function BuildDictionary2() As Dictionary(Of String, Element)
Return New Dictionary(Of String, Element) From
{
{"K", New Element With
{.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
{"Ca", New Element With
{.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
{"Sc", New Element With
{.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
{"Ti", New Element With
{.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
}
End Function
private Dictionary<string, Element> BuildDictionary2()
{
return new Dictionary<string, Element>
{
{"K",
new Element() { Symbol="K", Name="Potassium", AtomicNumber=19}},
{"Ca",
new Element() { Symbol="Ca", Name="Calcium", AtomicNumber=20}},
{"Sc",
new Element() { Symbol="Sc", Name="Scandium", AtomicNumber=21}},
{"Ti",
new Element() { Symbol="Ti", Name="Titanium", AtomicNumber=22}}
};
}
O exemplo a seguir usa o método ContainsKey e a propriedade Item de Dictionary para localizar rapidamente um item por chave. A propriedade Item permite que você acesse um item na coleção elements usando código de elements(symbol) no Visual Basic ou elements[symbol] no C#.
Private Sub FindInDictionary(ByVal symbol As String)
Dim elements As Dictionary(Of String, Element) = BuildDictionary()
If elements.ContainsKey(symbol) = False Then
Console.WriteLine(symbol & " not found")
Else
Dim theElement = elements(symbol)
Console.WriteLine("found: " & theElement.Name)
End If
End Sub
private void FindInDictionary(string symbol)
{
Dictionary<string, Element> elements = BuildDictionary();
if (elements.ContainsKey(symbol) == false)
{
Console.WriteLine(symbol + " not found");
}
else
{
Element theElement = elements[symbol];
Console.WriteLine("found: " + theElement.Name);
}
}
O exemplo a seguir usa o método TryGetValue para localizar rapidamente um item por chave.
Private Sub FindInDictionary2(ByVal symbol As String)
Dim elements As Dictionary(Of String, Element) = BuildDictionary()
Dim theElement As Element = Nothing
If elements.TryGetValue(symbol, theElement) = False Then
Console.WriteLine(symbol & " not found")
Else
Console.WriteLine("found: " & theElement.Name)
End If
End Sub
private void FindInDictionary2(string symbol)
{
Dictionary<string, Element> elements = BuildDictionary();
Element theElement = null;
if (elements.TryGetValue(symbol, out theElement) == false)
Console.WriteLine(symbol + " not found");
else
Console.WriteLine("found: " + theElement.Name);
}
Usando o LINQ para acessar uma coleção
LINQ (Language-Integrated Query) pode ser usado para acessar coleções. Consultas LINQ oferecem capacidades de filtragem, classificação e agrupamento. Para obter mais informações, consulte Introdução a LINQ no Visual Basic ou Introdução a LINQ em C#.
O exemplo a seguir executa uma consulta LINQ em uma List genérica. A consulta LINQ retorna uma coleção diferente com os resultados.
Private Sub ShowLINQ()
Dim elements As List(Of Element) = BuildList()
' LINQ Query.
Dim subset = From theElement In elements
Where theElement.AtomicNumber < 22
Order By theElement.Name
For Each theElement In subset
Console.WriteLine(theElement.Name & " " & theElement.AtomicNumber)
Next
' Output:
' Calcium 20
' Potassium 19
' Scandium 21
End Sub
Private Function BuildList() As List(Of Element)
Return New List(Of Element) From
{
{New Element With
{.Symbol = "K", .Name = "Potassium", .AtomicNumber = 19}},
{New Element With
{.Symbol = "Ca", .Name = "Calcium", .AtomicNumber = 20}},
{New Element With
{.Symbol = "Sc", .Name = "Scandium", .AtomicNumber = 21}},
{New Element With
{.Symbol = "Ti", .Name = "Titanium", .AtomicNumber = 22}}
}
End Function
Public Class Element
Public Property Symbol As String
Public Property Name As String
Public Property AtomicNumber As Integer
End Class
private void ShowLINQ()
{
List<Element> elements = BuildList();
// LINQ Query.
var subset = from theElement in elements
where theElement.AtomicNumber < 22
orderby theElement.Name
select theElement;
foreach (Element theElement in subset)
{
Console.WriteLine(theElement.Name + " " + theElement.AtomicNumber);
}
// Output:
// Calcium 20
// Potassium 19
// Scandium 21
}
private List<Element> BuildList()
{
return new List<Element>
{
{ new Element() { Symbol="K", Name="Potassium", AtomicNumber=19}},
{ new Element() { Symbol="Ca", Name="Calcium", AtomicNumber=20}},
{ new Element() { Symbol="Sc", Name="Scandium", AtomicNumber=21}},
{ new Element() { Symbol="Ti", Name="Titanium", AtomicNumber=22}}
};
}
public class Element
{
public string Symbol { get; set; }
public string Name { get; set; }
public int AtomicNumber { get; set; }
}
Classificando uma coleção
O exemplo a seguir ilustra um procedimento para a classificação de uma coleção. O exemplo classifica instâncias da classe Car que são armazenadas em List. A classe Car implementa a interface IComparable, que exige que o método CompareTo seja implementado.
Cada chamada para o método CompareTo faz uma única comparação que é usada para classificação. O código escrito pelo usuário no método de CompareTo retorna um valor para cada comparação do objeto atual com outro objeto. O valor retornado será menor do que zero se o objeto atual for menor do que o outro objeto, maior do que zero se o objeto atual for maior do que o outro objeto e zero se forem iguais. Isso permite que você defina no código os critérios para maior que, menor que e igual.
No método ListCars, a instrução cars.Sort() classifica a lista. Essa chamada para o método Sort de List faz com que o método CompareTo seja chamado automaticamente para os objetos Car em List.
Public Sub ListCars()
' Create some new cars.
Dim cars As New List(Of Car) From
{
New Car With {.Name = "car1", .Color = "blue", .Speed = 20},
New Car With {.Name = "car2", .Color = "red", .Speed = 50},
New Car With {.Name = "car3", .Color = "green", .Speed = 10},
New Car With {.Name = "car4", .Color = "blue", .Speed = 50},
New Car With {.Name = "car5", .Color = "blue", .Speed = 30},
New Car With {.Name = "car6", .Color = "red", .Speed = 60},
New Car With {.Name = "car7", .Color = "green", .Speed = 50}
}
' Sort the cars by color alphabetically, and then by speed
' in descending order.
cars.Sort()
' View all of the cars.
For Each thisCar As Car In cars
Console.Write(thisCar.Color.PadRight(5) & " ")
Console.Write(thisCar.Speed.ToString & " ")
Console.Write(thisCar.Name)
Console.WriteLine()
Next
' Output:
' blue 50 car4
' blue 30 car5
' blue 20 car1
' green 50 car7
' green 10 car3
' red 60 car6
' red 50 car2
End Sub
Public Class Car
Implements IComparable(Of Car)
Public Property Name As String
Public Property Speed As Integer
Public Property Color As String
Public Function CompareTo(ByVal other As Car) As Integer _
Implements System.IComparable(Of Car).CompareTo
' A call to this method makes a single comparison that is
' used for sorting.
' Determine the relative order of the objects being compared.
' Sort by color alphabetically, and then by speed in
' descending order.
' Compare the colors.
Dim compare As Integer
compare = String.Compare(Me.Color, other.Color, True)
' If the colors are the same, compare the speeds.
If compare = 0 Then
compare = Me.Speed.CompareTo(other.Speed)
' Use descending order for speed.
compare = -compare
End If
Return compare
End Function
End Class
private void ListCars()
{
var cars = new List<Car>
{
{ new Car() { Name = "car1", Color = "blue", Speed = 20}},
{ new Car() { Name = "car2", Color = "red", Speed = 50}},
{ new Car() { Name = "car3", Color = "green", Speed = 10}},
{ new Car() { Name = "car4", Color = "blue", Speed = 50}},
{ new Car() { Name = "car5", Color = "blue", Speed = 30}},
{ new Car() { Name = "car6", Color = "red", Speed = 60}},
{ new Car() { Name = "car7", Color = "green", Speed = 50}}
};
// Sort the cars by color alphabetically, and then by speed
// in descending order.
cars.Sort();
// View all of the cars.
foreach (Car thisCar in cars)
{
Console.Write(thisCar.Color.PadRight(5) + " ");
Console.Write(thisCar.Speed.ToString() + " ");
Console.Write(thisCar.Name);
Console.WriteLine();
}
// Output:
// blue 50 car4
// blue 30 car5
// blue 20 car1
// green 50 car7
// green 10 car3
// red 60 car6
// red 50 car2
}
public class Car : IComparable<Car>
{
public string Name { get; set; }
public int Speed { get; set; }
public string Color { get; set; }
public int CompareTo(Car other)
{
// A call to this method makes a single comparison that is
// used for sorting.
// Determine the relative order of the objects being compared.
// Sort by color alphabetically, and then by speed in
// descending order.
// Compare the colors.
int compare;
compare = String.Compare(this.Color, other.Color, true);
// If the colors are the same, compare the speeds.
if (compare == 0)
{
compare = this.Speed.CompareTo(other.Speed);
// Use descending order for speed.
compare = -compare;
}
return compare;
}
}
Definindo uma coleção personalizada
É possível definir uma coleção implementando a interface de IEnumerable ou de IEnumerable. Para obter informações adicionais, consulte Enumerando uma coleção e Como acessar uma classe de coleção com foreach (Guia de Programação em C#).
Embora você possa definir uma coleção personalizada, geralmente é melhor usar as coleções que estão incluídas no .NET Framework, que são descritas em Tipos de coleções anteriormente neste tópico.
O exemplo a seguir define uma classe de coleção personalizada chamada AllColors. Essa classe implementa a interface IEnumerable, o que exige que o método GetEnumerator seja implementado.
O método GetEnumerator retorna uma instância da classe ColorEnumerator. ColorEnumerator implementa a interface IEnumerator, que requer que a propriedade Current, o método MoveNext e o método Reset sejam implementados.
Public Sub ListColors()
Dim colors As New AllColors()
For Each theColor As Color In colors
Console.Write(theColor.Name & " ")
Next
Console.WriteLine()
' Output: red blue green
End Sub
' Collection class.
Public Class AllColors
Implements System.Collections.IEnumerable
Private _colors() As Color =
{
New Color With {.Name = "red"},
New Color With {.Name = "blue"},
New Color With {.Name = "green"}
}
Public Function GetEnumerator() As System.Collections.IEnumerator _
Implements System.Collections.IEnumerable.GetEnumerator
Return New ColorEnumerator(_colors)
' Instead of creating a custom enumerator, you could
' use the GetEnumerator of the array.
'Return _colors.GetEnumerator
End Function
' Custom enumerator.
Private Class ColorEnumerator
Implements System.Collections.IEnumerator
Private _colors() As Color
Private _position As Integer = -1
Public Sub New(ByVal colors() As Color)
_colors = colors
End Sub
Public ReadOnly Property Current() As Object _
Implements System.Collections.IEnumerator.Current
Get
Return _colors(_position)
End Get
End Property
Public Function MoveNext() As Boolean _
Implements System.Collections.IEnumerator.MoveNext
_position += 1
Return (_position < _colors.Length)
End Function
Public Sub Reset() Implements System.Collections.IEnumerator.Reset
_position = -1
End Sub
End Class
End Class
' Element class.
Public Class Color
Public Property Name As String
End Class
private void ListColors()
{
var colors = new AllColors();
foreach (Color theColor in colors)
{
Console.Write(theColor.Name + " ");
}
Console.WriteLine();
// Output: red blue green
}
// Collection class.
public class AllColors : System.Collections.IEnumerable
{
Color[] _colors =
{
new Color() { Name = "red" },
new Color() { Name = "blue" },
new Color() { Name = "green" }
};
public System.Collections.IEnumerator GetEnumerator()
{
return new ColorEnumerator(_colors);
// Instead of creating a custom enumerator, you could
// use the GetEnumerator of the array.
//return _colors.GetEnumerator();
}
// Custom enumerator.
private class ColorEnumerator : System.Collections.IEnumerator
{
private Color[] _colors;
private int _position = -1;
public ColorEnumerator(Color[] colors)
{
_colors = colors;
}
object System.Collections.IEnumerator.Current
{
get
{
return _colors[_position];
}
}
bool System.Collections.IEnumerator.MoveNext()
{
_position++;
return (_position < _colors.Length);
}
void System.Collections.IEnumerator.Reset()
{
_position = -1;
}
}
}
// Element class.
public class Color
{
public string Name { get; set; }
}
Iteradores
Um iterador é usado para executar uma iteração personalizada em uma coleção. Um iterador pode ser um método ou um acessador get. Um iterador usa uma instrução Yield (Visual Basic) ou yield return (C#) para retornar cada elemento da coleção um de cada vez.
Chame um iterador usando uma instrução de For each…Next (Visual Basic) ou de foreach (C#). Cada iteração do loop For Each chama o iterador. Quando uma declaração de Yield ou de yield return é obtida no iterador, uma expressão é retornada, e o local atual no código é mantido. A execução será reiniciada daquele local na próxima vez que o iterador for chamado.
Para obter mais informações, consulte Iteradores (C# e Visual Basic).
O exemplo a seguir usa um método iterador. O método iterador tem uma instrução Yield ou yield return que está dentro de um loop For…Next (Visual Basic) ou de um loop for (C#). No método ListEvenNumbers, cada iteração do corpo de instrução For Each cria uma chamada para o método de iterador, que continua para o próximo Yield ou instrução yield return.
Public Sub ListEvenNumbers()
For Each number As Integer In EvenSequence(5, 18)
Console.Write(number & " ")
Next
Console.WriteLine()
' Output: 6 8 10 12 14 16 18
End Sub
Private Iterator Function EvenSequence(
ByVal firstNumber As Integer, ByVal lastNumber As Integer) _
As IEnumerable(Of Integer)
' Yield even numbers in the range.
For number = firstNumber To lastNumber
If number Mod 2 = 0 Then
Yield number
End If
Next
End Function
private void ListEvenNumbers()
{
foreach (int number in EvenSequence(5, 18))
{
Console.Write(number.ToString() + " ");
}
Console.WriteLine();
// Output: 6 8 10 12 14 16 18
}
private static IEnumerable<int> EvenSequence(
int firstNumber, int lastNumber)
{
// Yield even numbers in the range.
for (var number = firstNumber; number <= lastNumber; number++)
{
if (number % 2 == 0)
{
yield return number;
}
}
}
Consulte também
Tarefas
Como acessar uma classe de coleção com foreach (Guia de Programação em C#)
Referência
Inicializadores de objeto e coleção (Guia de Programação em C#)
Conceitos
Inicializadores de coleção (Visual Basic)
Selecionando uma classe de coleção
Comparações e classificações dentro de coleções
Quando usar coleções genéricas
Outros recursos
Práticas recomendadas das coleções