Package org.apache.commons.collections4.bidimap

Class TreeBidiMap.ViewMapIterator

java.lang.Object

org.apache.commons.collections4.bidimap.TreeBidiMap.ViewIterator

org.apache.commons.collections4.bidimap.TreeBidiMap.ViewMapIterator

All Implemented Interfaces:

Iterator<K>, MapIterator<K,V>, OrderedIterator<K>, OrderedMapIterator<K,V>

Enclosing class:

TreeBidiMap<K extends Comparable<K>,V extends Comparable<V>>

class TreeBidiMap.ViewMapIterator
extends TreeBidiMap.ViewIterator
implements OrderedMapIterator<K,V>

An iterator over the map.

Field Summary

Fields inherited from class org.apache.commons.collections4.bidimap.TreeBidiMap.ViewIterator

lastReturnedNode

Constructor Summary

Constructors

Constructor	Description
ViewMapIterator(TreeBidiMap.DataElement orderType)	Constructor.

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().
K	next()	Gets the next key from the Map.
K	previous()	Gets the previous key from the Map.
V	setValue(V obj)	Sets the value associated with the current key (optional operation).

Methods inherited from class org.apache.commons.collections4.bidimap.TreeBidiMap.ViewIterator

hasNext, hasPrevious, navigateNext, navigatePrevious, remove

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

Methods inherited from interface org.apache.commons.collections4.MapIterator

hasNext, remove

Methods inherited from interface org.apache.commons.collections4.OrderedMapIterator

hasPrevious

Constructor Detail

ViewMapIterator

ViewMapIterator(TreeBidiMap.DataElement orderType)

Constructor.

Method Detail

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 extends Comparable<K>,V extends Comparable<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 extends Comparable<K>,V extends Comparable<V>>

Returns:

the current value

setValue

public V setValue(V obj)

Description copied from interface: MapIterator

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

Specified by:

setValue in interface MapIterator<K extends Comparable<K>,V extends Comparable<V>>

Parameters:

obj - the new value

Returns:

the previous value

next

public K next()

Description copied from interface: MapIterator

Gets the next key from the Map.

Specified by:

next in interface Iterator<K extends Comparable<K>>

Specified by:

next in interface MapIterator<K extends Comparable<K>,V extends Comparable<V>>

Returns:

the next key in the iteration

previous

public K previous()

Description copied from interface: OrderedMapIterator

Gets the previous key from the Map.

Specified by:

previous in interface OrderedIterator<K extends Comparable<K>>

Specified by:

previous in interface OrderedMapIterator<K extends Comparable<K>,V extends Comparable<V>>

Returns:

the previous key in the iteration