sirius.kernel.commons

Interface Trie.ContainmentIterator<V>

Enclosing class:

Trie<V>

public static interface Trie.ContainmentIterator<V>

Represents an iterator which navigates through the trie character by character.

Method Summary

Modifier and Type	Method and Description
boolean	canContinue(char c) Determines if the current path can be continued with the given character.
boolean	canGoBack() Determines if the iterator can backtrack.
boolean	doContinue(char c) Tries to continue the current path with the given character.
Set<Character>	getPossibilities() Returns a set of all possible continuations for the current state of the iterator
V	getValue() Returns the value associated with the key represented by the path traversed so far.
void	goBack() Undoes the latest transition to support backtracking
boolean	isCompleted() Determines if the iterator is currently pointing at a valid match.
void	reset() Restarts the iterator at the beginning of the trie.
boolean	resetWith(char c) Restarts the iterator at the beginning and tries to perform the next transition using the given character.
void	setValue(V value) Sets the value to be associated with the key represented by the path traversed so far

Method Detail

canContinue

boolean canContinue(char c)

Determines if the current path can be continued with the given character.

This will not change the internal state.

Parameters:

c - the character to continue with

Returns:

true if the current path can continued using the given character, false otherwise.

doContinue

boolean doContinue(char c)

Tries to continue the current path with the given character.

If the current path can be continued, the internal state will be updated. Otherwise the internal state will remain unchanged - the iterator is not reset automatically.

Parameters:

c - the character to continue with

Returns:

true if it was possible to continue using the given character, false otherwise

getValue

V getValue()

Returns the value associated with the key represented by the path traversed so far.

Returns:

the value represented by the path traversed to far or null if no value is available

setValue

void setValue(V value)

Sets the value to be associated with the key represented by the path traversed so far

Parameters:

value - the value to set

isCompleted

boolean isCompleted()

Determines if the iterator is currently pointing at a valid match.

Returns:

true if a value was previously associated with path traversed so far, false otherwise

canGoBack

boolean canGoBack()

Determines if the iterator can backtrack.

Returns:

true if at least one transition took place, flfalse if the iterator is at the root node.

goBack

void goBack()

Undoes the latest transition to support backtracking

getPossibilities

Set<Character> getPossibilities()

Returns a set of all possible continuations for the current state of the iterator

Returns:

a set of all possible characters to continue the current path

reset

void reset()

Restarts the iterator at the beginning of the trie.

resetWith

boolean resetWith(char c)

Restarts the iterator at the beginning and tries to perform the next transition using the given character.

Parameters:

c - the character to try to use after resetting the iterator

Returns:

true if the transition using c was possible, false otherwise. In this case the iterator remains in the "reset" state and can be used as if reset() was called.