Class AbstractOrderedMapIteratorDecorator
- java.lang.Object
-
- org.apache.commons.collections.iterators.AbstractOrderedMapIteratorDecorator
-
- All Implemented Interfaces:
Iterator
,MapIterator
,OrderedIterator
,OrderedMapIterator
public class AbstractOrderedMapIteratorDecorator extends Object implements OrderedMapIterator
Provides basic behaviour for decorating an ordered 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 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Stephen Colebourne
-
-
Field Summary
Fields Modifier and Type Field Description protected OrderedMapIterator
iterator
The iterator being decorated
-
Constructor Summary
Constructors Constructor Description AbstractOrderedMapIteratorDecorator(OrderedMapIterator iterator)
Constructor that decorates the specified iterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getKey()
Gets the current key, which is the key returned by the last call tonext()
.protected OrderedMapIterator
getOrderedMapIterator()
Gets the iterator being decorated.Object
getValue()
Gets the current value, which is the value associated with the last key returned bynext()
.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 theMap
.Object
previous()
Gets the previous key from theMap
.void
remove()
Removes the last returned key from the underlyingMap
(optional operation).Object
setValue(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
-
Methods inherited from interface java.util.Iterator
forEachRemaining
-
-
-
-
Field Detail
-
iterator
protected final OrderedMapIterator iterator
The iterator being decorated
-
-
Constructor Detail
-
AbstractOrderedMapIteratorDecorator
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
-
-
Method Detail
-
getOrderedMapIterator
protected OrderedMapIterator getOrderedMapIterator()
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 interfaceIterator
- Specified by:
hasNext
in interfaceMapIterator
- Returns:
true
if the iterator has more elements
-
next
public Object next()
Description copied from interface:MapIterator
Gets the next key from theMap
.- Specified by:
next
in interfaceIterator
- Specified by:
next
in interfaceMapIterator
- Returns:
- the next key in the iteration
-
hasPrevious
public boolean hasPrevious()
Description copied from interface:OrderedMapIterator
Checks to see if there is a previous entry that can be iterated to.- Specified by:
hasPrevious
in interfaceOrderedIterator
- Specified by:
hasPrevious
in interfaceOrderedMapIterator
- Returns:
true
if the iterator has a previous element
-
previous
public Object previous()
Description copied from interface:OrderedMapIterator
Gets the previous key from theMap
.- Specified by:
previous
in interfaceOrderedIterator
- Specified by:
previous
in interfaceOrderedMapIterator
- Returns:
- the previous key in the iteration
-
remove
public void remove()
Description copied from interface:MapIterator
Removes the last returned key from the underlyingMap
(optional operation).This method can be called once per call to
next()
.- Specified by:
remove
in interfaceIterator
- Specified by:
remove
in interfaceMapIterator
-
getKey
public Object getKey()
Description copied from interface:MapIterator
Gets the current key, which is the key returned by the last call tonext()
.- Specified by:
getKey
in interfaceMapIterator
- Returns:
- the current key
-
getValue
public Object getValue()
Description copied from interface:MapIterator
Gets the current value, which is the value associated with the last key returned bynext()
.- Specified by:
getValue
in interfaceMapIterator
- Returns:
- the current value
-
setValue
public Object setValue(Object obj)
Description copied from interface:MapIterator
Sets the value associated with the current key (optional operation).- Specified by:
setValue
in interfaceMapIterator
- Parameters:
obj
- the new value- Returns:
- the previous value
-
-