Class AbstractMapIteratorDecorator
java.lang.Object
org.apache.commons.collections.iterators.AbstractMapIteratorDecorator
- All Implemented Interfaces:
Iterator
,MapIterator
Provides basic behaviour for decorating a 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 -
Constructor Summary
ConstructorsConstructorDescriptionAbstractMapIteratorDecorator
(MapIterator iterator) Constructor that decorates the specified iterator. -
Method Summary
Modifier and TypeMethodDescriptiongetKey()
Gets the current key, which is the key returned by the last call tonext()
.protected MapIterator
Gets the iterator being decorated.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.next()
Gets the next 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).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 Details
-
iterator
The iterator being decorated
-
-
Constructor Details
-
AbstractMapIteratorDecorator
Constructor that decorates the specified iterator.- Parameters:
iterator
- the iterator to decorate, must not be null- Throws:
IllegalArgumentException
- if the collection is null
-
-
Method Details
-
getMapIterator
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
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
-
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
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
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
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
-