Package org.apache.commons.collections.iterators

Class AbstractOrderedMapIteratorDecorator

java.lang.Object
org.apache.commons.collections.iterators.AbstractOrderedMapIteratorDecorator
All Implemented Interfaces:
Iterator, MapIterator, OrderedIterator, OrderedMapIterator
public class AbstractOrderedMapIteratorDecorator extends Object implements OrderedMapIterator
Provides basic behaviour for decorating an ordered map iterator with extra functionality.

All methods are forwarded to the decorated map iterator.

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

  • Field Details

  • Constructor Details

    • AbstractOrderedMapIteratorDecorator

      public AbstractOrderedMapIteratorDecorator(OrderedMapIterator 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

    • getOrderedMapIterator

      protected OrderedMapIterator getOrderedMapIterator()
      Gets the iterator being decorated.
      Returns:
      the decorated iterator

    • hasNext

      public boolean hasNext()
      Description copied from interface: MapIterator
      Checks to see if there are more entries still to be iterated.
      Specified by:
      hasNext in interface Iterator
      Specified by:
      hasNext in interface MapIterator
      Returns:
      true if the iterator has more elements

    • next

      public Object next()
      Description copied from interface: MapIterator
      Gets the next key from the Map.
      Specified by:
      next in interface Iterator
      Specified by:
      next in interface MapIterator
      Returns:
      the next key in the iteration

    • hasPrevious

      public boolean hasPrevious()
      Description copied from interface: OrderedMapIterator
      Checks to see if there is a previous entry that can be iterated to.
      Specified by:
      hasPrevious in interface OrderedIterator
      Specified by:
      hasPrevious in interface OrderedMapIterator
      Returns:
      true if the iterator has a previous element

    • previous

      public Object previous()
      Description copied from interface: OrderedMapIterator
      Gets the previous key from the Map.
      Specified by:
      previous in interface OrderedIterator
      Specified by:
      previous in interface OrderedMapIterator
      Returns:
      the previous key in the iteration

    • remove

      public void remove()
      Description copied from interface: MapIterator
      Removes the last returned key from the underlying Map (optional operation).

      This method can be called once per call to next().

      Specified by:
      remove in interface Iterator
      Specified by:
      remove in interface MapIterator

    • getKey

      public Object getKey()
      Description copied from interface: MapIterator
      Gets the current key, which is the key returned by the last call to next().
      Specified by:
      getKey in interface MapIterator
      Returns:
      the current key

    • getValue

      public Object getValue()
      Description copied from interface: MapIterator
      Gets the current value, which is the value associated with the last key returned by next().
      Specified by:
      getValue in interface MapIterator
      Returns:
      the current value

    • setValue

      public Object setValue(Object obj)
      Description copied from interface: MapIterator
      Sets the value associated with the current key (optional operation).
      Specified by:
      setValue in interface MapIterator
      Parameters:
      obj - the new value
      Returns:
      the previous value