Class UnmodifiableOrderedMapIterator<K,V>
java.lang.Object
org.apache.commons.collections4.iterators.UnmodifiableOrderedMapIterator<K,V>
- Type Parameters:
K
- the type of keysV
- 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 Summary
Modifier 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()
.boolean
hasNext()
Checks to see if there are more entries still to be iterated.boolean
Checks 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
.void
remove()
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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Method Details
-
unmodifiableOrderedMapIterator
public 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 typeV
- the value type- Parameters:
iterator
- the iterator to decorate- Returns:
- a new unmodifiable ordered map iterator
- Throws:
NullPointerException
- if the iterator is null
-
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<K,
V> - Returns:
- the current key
-
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<K,
V> - Returns:
- the current value
-
hasNext
Description copied from interface:MapIterator
Checks to see if there are more entries still to be iterated. -
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<K>
- Specified by:
hasPrevious
in interfaceOrderedMapIterator<K,
V> - Returns:
true
if the iterator has a previous element
-
next
Description copied from interface:MapIterator
Gets the next key from theMap
. -
previous
Description copied from interface:OrderedMapIterator
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
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()
. -
setValue
Description copied from interface:MapIterator
Sets the value associated with the current key (optional operation).- Specified by:
setValue
in interfaceMapIterator<K,
V> - Parameters:
value
- the new value- Returns:
- the previous value
-