Package org.apache.commons.collections4.trie

Class AbstractPatriciaTrie.TrieMapIterator

java.lang.Object

org.apache.commons.collections4.trie.AbstractPatriciaTrie.TrieIterator<K>

org.apache.commons.collections4.trie.AbstractPatriciaTrie.TrieMapIterator

All Implemented Interfaces:

java.util.Iterator<K>, MapIterator<K,V>, OrderedIterator<K>, OrderedMapIterator<K,V>

Enclosing class:

AbstractPatriciaTrie<K,V>

private class AbstractPatriciaTrie.TrieMapIterator
extends AbstractPatriciaTrie.TrieIterator<K>
implements OrderedMapIterator<K,V>

An OrderedMapIterator for a Trie.

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractPatriciaTrie.TrieEntry<K,V>	previous

Fields inherited from class org.apache.commons.collections4.trie.AbstractPatriciaTrie.TrieIterator

current, expectedModCount, next

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TrieMapIterator()

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	hasPrevious()	Checks to see if there is a previous entry that can be iterated to.
K	next()	Gets the next key from the Map.
protected AbstractPatriciaTrie.TrieEntry<K,V>	nextEntry()	Returns the next AbstractPatriciaTrie.TrieEntry.
K	previous()	Gets the previous key from the Map.
protected AbstractPatriciaTrie.TrieEntry<K,V>	previousEntry()
V	setValue(V value)	Sets the value associated with the current key (optional operation).

Methods inherited from class org.apache.commons.collections4.trie.AbstractPatriciaTrie.TrieIterator

findNext, hasNext, 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

Field Detail

previous

protected AbstractPatriciaTrie.TrieEntry<K,V> previous

Constructor Detail

TrieMapIterator

private TrieMapIterator()

Method Detail

next

public K next()

Description copied from interface: MapIterator

Gets the next key from the Map.

Specified by:

next in interface java.util.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

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

hasPrevious

public boolean hasPrevious()

Description copied from interface: OrderedMapIterator

Checks to see if there is a previous entry that can be iterated to.

Specified by:

hasPrevious in interface OrderedIterator<K>

Specified by:

hasPrevious in interface OrderedMapIterator<K,V>

Returns:

true if the iterator has a previous element

previous

public K previous()

Description copied from interface: OrderedMapIterator

Gets the previous key from the Map.

Specified by:

previous in interface OrderedIterator<K>

Specified by:

previous in interface OrderedMapIterator<K,V>

Returns:

the previous key in the iteration

nextEntry

protected AbstractPatriciaTrie.TrieEntry<K,V> nextEntry()

Description copied from class: AbstractPatriciaTrie.TrieIterator

Returns the next AbstractPatriciaTrie.TrieEntry.

Overrides:

nextEntry in class AbstractPatriciaTrie.TrieIterator<K>

previousEntry

protected AbstractPatriciaTrie.TrieEntry<K,V> previousEntry()