public class

AbstractOrderedMapIteratorDecorator

extends Object
implements OrderedMapIterator
java.lang.Object
   ↳ org.apache.commons.collections.iterators.AbstractOrderedMapIteratorDecorator

Class Overview

Provides basic behaviour for decorating an ordered map iterator with extra functionality.

All methods are forwarded to the decorated map iterator.

Summary

Fields
protected final OrderedMapIterator iterator The iterator being decorated
Public Constructors
AbstractOrderedMapIteratorDecorator(OrderedMapIterator iterator)
Constructor that decorates the specified iterator.
Public Methods
Object getKey()
Gets the current key, which is the key returned by the last call to next().
Object getValue()
Gets the current value, which is the value associated with the last key returned by next().
boolean hasNext()
Checks to see if there are more entries still to be iterated.
boolean hasPrevious()
Checks to see if there is a previous entry that can be iterated to.
Object next()
Gets the next key from the Map.
Object previous()
Gets the previous key from the Map.
void remove()
Removes the last returned key from the underlying Map (optional operation).
Object setValue(Object obj)
Sets the value associated with the current key (optional operation).
Protected Methods
OrderedMapIterator getOrderedMapIterator()
Gets the iterator being decorated.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator
From interface org.apache.commons.collections.MapIterator
From interface org.apache.commons.collections.OrderedIterator
From interface org.apache.commons.collections.OrderedMapIterator

Fields

protected final OrderedMapIterator iterator

The iterator being decorated

Public Constructors

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

Public Methods

public Object getKey ()

Gets the current key, which is the key returned by the last call to next().

Returns
  • the current key

public Object getValue ()

Gets the current value, which is the value associated with the last key returned by next().

Returns
  • the current value

public boolean hasNext ()

Checks to see if there are more entries still to be iterated.

Returns
  • true if the iterator has more elements

public boolean hasPrevious ()

Checks to see if there is a previous entry that can be iterated to.

Returns
  • true if the iterator has a previous element

public Object next ()

Gets the next key from the Map.

Returns
  • the next key in the iteration

public Object previous ()

Gets the previous key from the Map.

Returns
  • the previous key in the iteration

public void remove ()

Removes the last returned key from the underlying Map (optional operation).

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

public Object setValue (Object obj)

Sets the value associated with the current key (optional operation).

Parameters
obj the new value
Returns
  • the previous value

Protected Methods

protected OrderedMapIterator getOrderedMapIterator ()

Gets the iterator being decorated.

Returns
  • the decorated iterator