Class AbstractOrderedMapIteratorDecorator<K,V>
- java.lang.Object
-
- org.apache.commons.collections4.iterators.AbstractOrderedMapIteratorDecorator<K,V>
-
- Type Parameters:
K
- the type of keysV
- the type of mapped values
- All Implemented Interfaces:
java.util.Iterator<K>
,MapIterator<K,V>
,OrderedIterator<K>
,OrderedMapIterator<K,V>
public class AbstractOrderedMapIteratorDecorator<K,V> extends java.lang.Object implements OrderedMapIterator<K,V>
Provides basic behaviour for decorating an ordered map iterator with extra functionality.All methods are forwarded to the decorated map iterator.
- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description AbstractOrderedMapIteratorDecorator(OrderedMapIterator<K,V> iterator)
Constructor that decorates the specified iterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description K
getKey()
Gets the current key, which is the key returned by the last call tonext()
.V
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.K
next()
Gets the next key from theMap
.K
previous()
Gets the previous key from theMap
.void
remove()
Removes the last returned key from the underlyingMap
(optional operation).V
setValue(V obj)
Sets the value associated with the current key (optional operation).
-
-
-
Constructor Detail
-
AbstractOrderedMapIteratorDecorator
public AbstractOrderedMapIteratorDecorator(OrderedMapIterator<K,V> iterator)
Constructor that decorates the specified iterator.- Parameters:
iterator
- the iterator to decorate, must not be null- Throws:
java.lang.NullPointerException
- if the iterator is null
-
-
Method Detail
-
hasNext
public boolean hasNext()
Checks to see if there are more entries still to be iterated.- Specified by:
hasNext
in interfacejava.util.Iterator<K>
- Specified by:
hasNext
in interfaceMapIterator<K,V>
- Returns:
true
if the iterator has more elements
-
next
public K next()
Gets the next key from theMap
.- Specified by:
next
in interfacejava.util.Iterator<K>
- Specified by:
next
in interfaceMapIterator<K,V>
- Returns:
- the next key in the iteration
-
hasPrevious
public boolean hasPrevious()
Checks to see if there is a previous entry that can be iterated to.- Specified by:
hasPrevious
in interfaceOrderedIterator<K>
- Specified by:
hasPrevious
in interfaceOrderedMapIterator<K,V>
- Returns:
true
if the iterator has a previous element
-
previous
public K previous()
Gets the previous key from theMap
.- Specified by:
previous
in interfaceOrderedIterator<K>
- Specified by:
previous
in interfaceOrderedMapIterator<K,V>
- Returns:
- the previous key in the iteration
-
remove
public void remove()
Removes the last returned key from the underlyingMap
(optional operation).This method can be called once per call to
next()
.- Specified by:
remove
in interfacejava.util.Iterator<K>
- Specified by:
remove
in interfaceMapIterator<K,V>
-
getKey
public K getKey()
Gets the current key, which is the key returned by the last call tonext()
.- Specified by:
getKey
in interfaceMapIterator<K,V>
- Returns:
- the current key
-
getValue
public V getValue()
Gets the current value, which is the value associated with the last key returned bynext()
.- Specified by:
getValue
in interfaceMapIterator<K,V>
- Returns:
- the current value
-
-