Class AbstractIteratorDecorator

java.lang.Object
org.apache.commons.collections.iterators.AbstractIteratorDecorator
All Implemented Interfaces:
Iterator
Direct Known Subclasses:
AbstractDualBidiMap.EntrySetIterator, AbstractDualBidiMap.KeySetIterator, AbstractDualBidiMap.ValuesIterator

public class AbstractIteratorDecorator extends Object implements Iterator
Provides basic behaviour for decorating an iterator with extra functionality.

All methods are forwarded to the decorated iterator.

Since:
Commons Collections 3.0
Version:
$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
Author:
James Strachan, Stephen Colebourne
  • Field Details

    • iterator

      protected final Iterator iterator
      The iterator being decorated
  • Constructor Details

    • AbstractIteratorDecorator

      public AbstractIteratorDecorator(Iterator iterator)
      Constructor that decorates the specified iterator.
      Parameters:
      iterator - the iterator to decorate, must not be null
      Throws:
      IllegalArgumentException - if the collection is null
  • Method Details

    • getIterator

      protected Iterator getIterator()
      Gets the iterator being decorated.
      Returns:
      the decorated iterator
    • hasNext

      public boolean hasNext()
      Specified by:
      hasNext in interface Iterator
    • next

      public Object next()
      Specified by:
      next in interface Iterator
    • remove

      public void remove()
      Specified by:
      remove in interface Iterator