org.apache.commons.collections.iterators

Class AbstractOrderedMapIteratorDecorator

Implemented Interfaces:
Iterator, MapIterator, OrderedIterator, OrderedMapIterator

public class AbstractOrderedMapIteratorDecorator
extends java.lang.Object
implements OrderedMapIterator

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

All methods are forwarded to the decorated map iterator.

Version:
$Revision: 1.4 $ $Date: 2004/02/18 00:59:50 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

protected OrderedMapIterator
iterator
The iterator being decorated

Constructor Summary

AbstractOrderedMapIteratorDecorator(OrderedMapIterator 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 OrderedMapIterator
getOrderedMapIterator()
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.
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).

Field Details

iterator

protected final OrderedMapIterator iterator
The iterator being decorated

Constructor Details

AbstractOrderedMapIteratorDecorator

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

getOrderedMapIterator

protected OrderedMapIterator getOrderedMapIterator()
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

hasPrevious

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

next

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

previous

public Object previous()
Gets the previous key from the Map.
Specified by:
previous in interface OrderedMapIterator
previous in interface OrderedIterator
Returns:
the previous 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-2006 Apache Software Foundation. All Rights Reserved.