org.apache.commons.collections.iterators
Class AbstractOrderedMapIteratorDecorator
java.lang.Object
org.apache.commons.collections.iterators.AbstractOrderedMapIteratorDecorator
- Iterator, MapIterator, OrderedIterator, OrderedMapIterator
public class AbstractOrderedMapIteratorDecorator
extends java.lang.Object
Provides basic behaviour for decorating an ordered map iterator with extra functionality.
All methods are forwarded to the decorated map iterator.
$Revision: 1.4 $ $Date: 2004/02/18 00:59:50 $
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).
|
AbstractOrderedMapIteratorDecorator
public AbstractOrderedMapIteratorDecorator(OrderedMapIterator iterator)
Constructor that decorates the specified iterator.
iterator
- the iterator to decorate, must not be null
getKey
public Object getKey()
Gets the current key, which is the key returned by the last call
to next()
.
- getKey in interface MapIterator
getOrderedMapIterator
protected OrderedMapIterator getOrderedMapIterator()
Gets the iterator being decorated.
getValue
public Object getValue()
Gets the current value, which is the value associated with the last key
returned by next()
.
- getValue in interface MapIterator
hasNext
public boolean hasNext()
Checks to see if there are more entries still to be iterated.
- hasNext in interface MapIterator
true
if the iterator has more elements
next
public Object next()
Gets the next key from the Map
.
- next in interface MapIterator
- 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()
.
- remove in interface MapIterator
setValue
public Object setValue(Object obj)
Sets the value associated with the current key (optional operation).
- setValue in interface MapIterator
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.