org.apache.commons.collections.iterators

Class AbstractMapIteratorDecorator

Implemented Interfaces:
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.

Version:
$Revision: 1.6 $ $Date: 2004/02/18 00:59:50 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

Field Summary

protected MapIterator
iterator
The iterator being decorated

Constructor Summary

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

Method Summary

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.
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.
Object
next()
Gets the next 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).

Field Details

iterator

protected final MapIterator iterator
The iterator being decorated

Constructor Details

AbstractMapIteratorDecorator

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

Parameters:
iterator - the iterator to decorate, must not be null

Method Details

getKey

public Object getKey()
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


getMapIterator

protected MapIterator getMapIterator()
Gets the iterator being decorated.

Returns:
the decorated iterator


getValue

public Object getValue()
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


hasNext

public boolean hasNext()
Checks to see if there are more entries still to be iterated.
Specified by:
hasNext in interface MapIterator

Returns:
true if the iterator has more elements


next

public Object next()
Gets the next key from the Map.
Specified by:
next in interface MapIterator

Returns:
the next key in the iteration


remove

public void remove()
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 MapIterator


setValue

public Object setValue(Object obj)
Sets the value associated with the current key (optional operation).
Specified by:
setValue in interface MapIterator

Parameters:

Returns:
the previous value


Copyright © 2001-2005 Apache Software Foundation. All Rights Reserved.