org.apache.commons.collections.iterators
Class AbstractMapIteratorDecorator

java.lang.Object
  org.apache.commons.collections.iterators.AbstractMapIteratorDecorator

All Implemented Interfaces:

java.util.Iterator, MapIterator

public class AbstractMapIteratorDecorator
extends java.lang.Object
implements MapIterator

Provides basic behaviour for decorating a 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 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

Field Summary

protected MapIterator

iterator The iterator being decorated

Constructor Summary

AbstractMapIteratorDecorator(MapIterator iterator)
Constructor that decorates the specified iterator.

Method Summary

java.lang.Object	getKey() Gets the current key, which is the key returned by the last call to next().
protected MapIterator	getMapIterator() Gets the iterator being decorated.
java.lang.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.
java.lang.Object	next() Gets the next key from the Map.
void	remove() Removes the last returned key from the underlying Map (optional operation).
java.lang.Object	setValue(java.lang.Object obj) Sets the value associated with the current key (optional operation).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iterator

protected final MapIterator iterator

The iterator being decorated

Constructor Detail

AbstractMapIteratorDecorator

public AbstractMapIteratorDecorator(MapIterator iterator)

Constructor that decorates the specified iterator.

Parameters:

iterator - the iterator to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if the collection is null

Method Detail

getMapIterator

protected MapIterator getMapIterator()

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 java.util.Iterator

Specified by:

hasNext in interface MapIterator

Returns:

true if the iterator has more elements

next

public java.lang.Object next()

Description copied from interface: MapIterator

Gets the next key from the Map.

Specified by:

next in interface java.util.Iterator

Specified by:

next in interface MapIterator

Returns:

the next 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 java.util.Iterator

Specified by:

remove in interface MapIterator

getKey

public java.lang.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 java.lang.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 java.lang.Object setValue(java.lang.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