Class AbstractOrderedMapIteratorDecorator<K,V> 
java.lang.Object
org.apache.commons.collections4.iterators.AbstractOrderedMapIteratorDecorator<K,V> 
- Type Parameters:
- K- the type of keys
- V- the type of mapped values
- All Implemented Interfaces:
- Iterator<K>,- MapIterator<K,,- V> - OrderedIterator<K>,- OrderedMapIterator<K,- V> 
public class AbstractOrderedMapIteratorDecorator<K,V> 
extends Object
implements OrderedMapIterator<K,V> 
Provides basic behavior for decorating an ordered map iterator with extra functionality.
 
All methods are forwarded to the decorated map iterator.
- Since:
- 3.0
- 
Constructor SummaryConstructorsConstructorDescriptionAbstractOrderedMapIteratorDecorator(OrderedMapIterator<K, V> iterator) Constructor that decorates the specified iterator.
- 
Method SummaryModifier and TypeMethodDescriptiongetKey()Gets the current key, which is the key returned by the last call tonext().protected OrderedMapIterator<K, V> Gets the iterator being decorated.getValue()Gets the current value, which is the value associated with the last key returned bynext().booleanhasNext()Checks to see if there are more entries still to be iterated.booleanChecks to see if there is a previous entry that can be iterated to.next()Gets the next key from theMap.previous()Gets the previous key from theMap.voidremove()Removes the last returned key from the underlyingMap(optional operation).Sets the value associated with the current key (optional operation).Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.IteratorforEachRemaining
- 
Constructor Details- 
AbstractOrderedMapIteratorDecoratorConstructor that decorates the specified iterator.- Parameters:
- iterator- the iterator to decorate, must not be null
- Throws:
- NullPointerException- if the iterator is null
 
 
- 
- 
Method Details- 
getKey
- 
getOrderedMapIteratorGets the iterator being decorated.- Returns:
- the decorated iterator
 
- 
getValue
- 
hasNext
- 
hasPreviousChecks to see if there is a previous entry that can be iterated to.- Specified by:
- hasPreviousin interface- OrderedIterator<K>
- Specified by:
- hasPreviousin interface- OrderedMapIterator<K,- V> 
- Returns:
- trueif the iterator has a previous element
 
- 
next
- 
previousGets the previous key from theMap.- Specified by:
- previousin interface- OrderedIterator<K>
- Specified by:
- previousin interface- OrderedMapIterator<K,- V> 
- Returns:
- the previous key in the iteration
 
- 
remove
- 
setValue
 
-