6.1. Creating an lterator on a Generic Type
Problem
You want elements contained in your generic type to be enumerated using the foreach statement.
Solution
Add an iterator to your generic type, as shown here:
public class ShoppingList<T> : IEnumerable<T>
{
private List<T> _items = new List<T>();
public void Add(T name)
{
_items.Add(name);
}
public IEnumerator<T> GetEnumerator()
{
return _items.GetEnumerator();
}
}The following code creates a new ShoppingList<T> object and fills it with strings; it then proceeds to use a foreach loop to enumerate and display each string:
public static void TestShoppingCart()
{
//Create ShoppingList object and fill it with data
ShoppingList<string> shoppingCart = new ShoppingList<string>(){
"item1","item2","item3","item4","item5","item6"};
// Display all data in ShoppingCart object
foreach (string item in shoppingCart)
{
Console.WriteLine(item);
}
}Discussion
Adding an iterator to a generic type is accomplished by implementing the IEnumerator<T> interface. The method to implement for IEnumerator<T> is the GetEnumerator method that accepts no arguments and returns an IEnumerator<T> type. The GetNext method on the object returned by this GetEnumerator method is called by the foreach loop to determine what object is returned on every iteration.
The code that you write inside of the GetEnumerator method is what actually does the work of determining the next object to be returned by the foreach loop. This is accomplished through the use of the yield return ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access