Class UnmodifiableOrderedMapIterator<K,V> 
java.lang.Object
org.apache.commons.collections4.iterators.UnmodifiableOrderedMapIterator<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> - Unmodifiable
public final class UnmodifiableOrderedMapIterator<K,V> 
extends Object
implements OrderedMapIterator<K,V>, Unmodifiable 
Decorates an ordered map iterator such that it cannot be modified.
 
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 3.0
- 
Method SummaryModifier and TypeMethodDescriptiongetKey()Gets the current key, which is the key returned by the last call tonext().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).static <K,V> OrderedMapIterator <K, V> unmodifiableOrderedMapIterator(OrderedMapIterator<K, ? extends V> iterator) Decorates the specified iterator such that it cannot be modified.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.IteratorforEachRemaining
- 
Method Details- 
unmodifiableOrderedMapIteratorpublic static <K,V> OrderedMapIterator<K,V> unmodifiableOrderedMapIterator(OrderedMapIterator<K, ? extends V> iterator) Decorates the specified iterator such that it cannot be modified.- Type Parameters:
- K- the key type
- V- the value type
- Parameters:
- iterator- the iterator to decorate
- Returns:
- a new unmodifiable ordered map iterator
- Throws:
- NullPointerException- if the iterator is null
 
- 
getKeyDescription copied from interface:MapIteratorGets the current key, which is the key returned by the last call tonext().- Specified by:
- getKeyin interface- MapIterator<K,- V> 
- Returns:
- the current key
 
- 
getValueDescription copied from interface:MapIteratorGets the current value, which is the value associated with the last key returned bynext().- Specified by:
- getValuein interface- MapIterator<K,- V> 
- Returns:
- the current value
 
- 
hasNextDescription copied from interface:MapIteratorChecks to see if there are more entries still to be iterated.
- 
hasPreviousDescription copied from interface:OrderedMapIteratorChecks 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
 
- 
nextDescription copied from interface:MapIteratorGets the next key from theMap.
- 
previousDescription copied from interface:OrderedMapIteratorGets 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
 
- 
removeDescription copied from interface:MapIteratorRemoves the last returned key from the underlyingMap(optional operation).This method can be called once per call to next().
- 
setValueDescription copied from interface:MapIteratorSets the value associated with the current key (optional operation).- Specified by:
- setValuein interface- MapIterator<K,- V> 
- Parameters:
- value- the new value
- Returns:
- the previous value
 
 
-