Class AbstractMultiValuedMap.MultiValuedMapIterator

java.lang.Object

org.apache.commons.collections4.multimap.AbstractMultiValuedMap.MultiValuedMapIterator

All Implemented Interfaces:

Iterator<K>, MapIterator<K,V>

Enclosing class:

AbstractMultiValuedMap<K,V>

private class AbstractMultiValuedMap.MultiValuedMapIterator
extends Object
implements MapIterator<K,V>

Inner class for MapIterator.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
private Map.Entry<K,V>	current
private final Iterator<Map.Entry<K,V>>	it

Constructor Summary

Constructors

Constructor	Description
MultiValuedMapIterator()

Method Summary

Modifier and Type	Method	Description
K	getKey()	Gets the current key, which is the key returned by the last call to next().
V	getValue()	Gets the current value, which is the value associated with the last key returned by next().
boolean	hasNext()	Checks to see if there are more entries still to be iterated.
K	next()	Gets the next key from the Map.
void	remove()	Removes the last returned key from the underlying Map (optional operation).
V	setValue(V value)	Sets the value associated with the current key (optional operation).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterator

forEachRemaining

Field Details

it

private final Iterator<Map.Entry<K,V>> it

current

private Map.Entry<K,V> current

Constructor Details

MultiValuedMapIterator

public MultiValuedMapIterator()

Method Details

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 interface Iterator<K>

Specified by:

hasNext in interface MapIterator<K,V>

Returns:

true if the iterator has more elements

next

public K next()

Description copied from interface: MapIterator

Gets the next key from the Map.

Specified by:

next in interface Iterator<K>

Specified by:

next in interface MapIterator<K,V>

Returns:

the next key in the iteration

getKey

public K getKey()

Description copied from interface: MapIterator

Gets the current key, which is the key returned by the last call to next().

Specified by:

getKey in interface MapIterator<K,V>

Returns:

the current key

getValue

public V getValue()

Description copied from interface: MapIterator

Gets the current value, which is the value associated with the last key returned by next().

Specified by:

getValue in interface MapIterator<K,V>

Returns:

the current value

remove

public void remove()

Description copied from interface: MapIterator

Removes the last returned key from the underlying Map (optional operation).

This method can be called once per call to next().

Specified by:

remove in interface Iterator<K>

Specified by:

remove in interface MapIterator<K,V>

setValue

public V setValue(V value)

Description copied from interface: MapIterator

Sets the value associated with the current key (optional operation).

Specified by:

setValue in interface MapIterator<K,V>

Parameters:

value - the new value

Returns:

the previous value