Iterator Design Pattern - C#

Shailendra Chauhan

Print 3 min read

23 Aug 2022

Intermediate

31.4K Views

Iterator Design Pattern falls under Behavioral Pattern of Gang of Four (GOF) Design Patterns in .Net. The command pattern is commonly used in the menu systems of many applications such as Editor, IDE, etc. In this article, I would like to share what is iterator pattern and how is it work?

What is Iterator Design Pattern?

Iterator Design Pattern provides a way to access the elements of a collection object in a sequential manner without knowing its underlying structure.

This pattern is commonly used in the menu systems of many applications such as Editor, IDE, etc.

Iterator Design pattern - UML Diagram & Implementation

The UML class diagram for the implementation of the Iterator Design pattern is given below:

The classes, interfaces, and objects in the above UML class diagram are as follows:

Client
This is the class that contains an object collection and uses the Next operation of the iterator to retrieve items from the aggregate in an appropriate sequence.
Iterator
This is an interface that defines operations for accessing the collection elements in a sequence.
ConcreteIterator
This is a class that implements the Iterator interface.
Aggregate
This is an interface which defines an operation to create an iterator.
ConcreteAggregate
This is a class that implements an Aggregate interface.

C# - Implementation Code

public class Client
{
 public void UseIterator()
 {
 ConcreteAggregate aggr = new ConcreteAggregate();
 aggr.Add("One");
 aggr.Add("Two");
 aggr.Add("Three");
 aggr.Add("Four");
 aggr.Add("Five");

 Iterator iterator = aggr.CreateIterator();
 while (iterator.Next())
 {
 string item = (string)iterator.Current;
 Console.WriteLine(item);
 }
 }
}

public interface Aggregate
{
 Iterator CreateIterator();
}

public class ConcreteAggregate : Aggregate
{
 private ArrayList items = new ArrayList();

 public Iterator CreateIterator()
 {
 return new ConcreteIterator(this);
 }

 public object this[int index]
 {
 get { return items[index]; }
 }

 public int Count
 {
 get { return items.Count; }
 }

 public void Add(object o)
 {
 items.Add(o);
 }
}
public interface Iterator
{
 object Current { get; }
 bool Next();

}

public class ConcreteIterator : Iterator
{
 private ConcreteAggregate aggregate;
 int index;

 public ConcreteIterator(ConcreteAggregate aggregate)
 {
 this.aggregate = aggregate;
 index = -1;
 }

 public bool Next()
 {
 index++;
 return index < aggregate.Count;
 }

 public object Current
 {
 get
 {
 if (index < aggregate.Count)
 return aggregate[index];
 else
 throw new InvalidOperationException();
 }
 }
}

Real Life Example:

When to use it?

Allows accessing the elements of a collection object in a sequential manner without knowing its underlying structure.
Multiple or concurrent iterations are required over collections elements.
Provides a uniform interface for accessing the collection elements.

What do you think?

I hope you will enjoy the Iterator Design Pattern while designing your software. I would like to have feedback from my blog readers. Your valuable feedback, question, or comments about this article are always welcome.