Skip to main content

Iterator Pattern

Iterator Pattern 


Gamma Categorization: Behavioral Design Pattern
Summary: Provide a way to access the elements of an aggregate object sequentially without exposing its underlying representation.

Sample Code

Problem: We want to apply several commands on the digital camera.

Code

public class Photo
{
    public string Name { get; set; }

    public Photo(string name)
    {
        this.Name = name;
    }
}

public interface IPhotoCollection
{
    IPhotoIterator CreateIterator();
}

public interface IPhotoIterator
{
    Photo First();
    Photo Next();
    bool IsDone { get; }
    Photo CurrentPhoto { get; }
}

public class PhotoCollection : IPhotoCollection
{
    private ArrayList _items = new ArrayList();

    public IPhotoIterator CreateIterator()
    {
        return new PhotoIterator(this);
    }

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

    public object this[int index]
    {
        get { return _items[index]; }
        set { _items.Add(value); }
    }
}

public class PhotoIterator : IPhotoIterator
{
    private PhotoCollection _photos;
    private int _current = 0;
    private int _step = 1;

    public Photo CurrentPhoto { get { return _photos[_current] as Photo; } }

    public bool IsDone { get { return _current >= _photos.Count; } }

    public PhotoIterator(PhotoCollection photos)
    {
        this._photos = photos;
    }

    public Photo First()
    {
        _current = 0;
        return _photos[_current] as Photo;
    }

    public Photo Next()
    {
        _current += _step;
        if (!IsDone)
            return _photos[_current] as Photo;
        else
            return null;
    }
}

Usage

PhotoCollection photoCollection = new PhotoCollection();
photoCollection[0] = new Photo("IMG_01");
photoCollection[1] = new Photo("IMG_02");
photoCollection[2] = new Photo("IMG_03");
photoCollection[3] = new Photo("IMG_04");
photoCollection[4] = new Photo("IMG_05");
photoCollection[5] = new Photo("IMG_06");
photoCollection[6] = new Photo("IMG_07");
photoCollection[7] = new Photo("IMG_08");
photoCollection[8] = new Photo("IMG_09");

PhotoIterator photoIterator = new PhotoIterator(photoCollection);

for (Photo p = photoIterator.First(); !photoIterator.IsDone; p = photoIterator.Next())
{
    System.Console.WriteLine($"{p.Name}");           
}

Output

IMG_01
IMG_02
IMG_03
IMG_04
IMG_05
IMG_06
IMG_07
IMG_08
IMG_09

Comments

Popular posts from this blog

Software Development

Software Development Agile Agile is an insurance policy for market changes. By designing your solution according to this methodology, your project remains flexible and is always ready for change. It is always better to correct the mistake early in the process. With this method, you keep your finger on the pulse of a dynamic market and changing user expectations. As a result, you can continuously adapt, change your strategy, and create a product that will be in demand by the target audience, even if preferences have changed during the development process. DevOps DevOps is one more way to optimize the development budget of your application. A key DevOps approach is that this practice and its culture allow team members to better interact with each other and the customer. The software development team and those responsible for the operation of the application share responsibilities clearly, and it helps you avoid shifting responsibilities from one team member to another. DevOps involves th...

XML Webservice (ASMX) - SOAP Request and Response Invocation logging

You are an integration developer. Eventualy you came into the state where there is nothing else you can debug, and you have to check which SOAP request it is built on the request, and which SOAP response you are getting from the server. C# XML Webservice (ASMX) - SOAP Request and Response Invocation logging In the legaccy .NET framework System.Web.Services , this means using soapExtensions to help you intersept the interaction with the webservice. This is done like so:  public class TraceExtension : SoapExtension     {         Stream oldStream;         Stream newStream;         string filename;         // Save the Stream representing the SOAP request or SOAP response into          // a local memory buffer.          public override Stream ChainStream(Stream stream)         {           ...

SOLID (3/5) - Liskov substitution principle

  SOLID (3/5) - Liskov substitution principle Substitutability is a principle in object-oriented programming stating that, in a computer program, if S is a subtype of T, then objects of type T may be replaced with objects of type S (i.e., an object of type T may be substituted with any object of a subtype S) without altering any of the desirable properties of the program (correctness, task performed, etc.). More formally, the Liskov substitution principle (LSP) is a particular definition of a subtyping relation, called (strong) behavioral subtyping. It is a semantic rather than merely syntactic relation, because it intends to guarantee semantic interoperability of types in a hierarchy, object types in particular. using   System ; namespace   Liskov {      public   class   Rectangle     {          //public int Width { get; set; }   ...