com.screenscraper.view.languagesupport.javadoc

Class SimpleTrie<T,U>

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.SimpleTrie<T,U>

Type Parameters:

T - The type of objects stored in the trie paths

U - The type of objects stored in the trie end points

public class SimpleTrie<T,U>
extends java.lang.Object

A simple trie for efficiently storing objects with similar roots and leaves. This doesn't support deletion

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
SimpleTrie() Creates a new trie

Method Summary

Modifier and Type	Method and Description
void	addChild(java.util.List<T> path) Adds a child along the given path, and marks the last element node as a valid end point
void	addChild(T... elements) Adds a child along the given path, and marks the last element node as a valid end point
boolean	equals(java.lang.Object otherObject)
SimpleTrie<T,U>	getChild(java.util.List<T> path) Gets the child at the end of the given path (or null if there is no such element)
SimpleTrie<T,U>	getChild(T... elements) Gets the child at the end of the given path (or null if there is no such element)
java.util.Map<T,SimpleTrie<T,U>>	getChildren() Returns the child map for this level of the trie.
U	getEndPointValue() Returns the end-point value for this node, regardless of if it's a valid end point.
boolean	hasChild(T... elements) Checks if there is a child node by following the given path
int	hashCode()
boolean	hasValidEndPoint(java.util.List<T> path) Checks if there is a valid end node at the end of the given path
boolean	hasValidEndPoint(T... elements) Checks if there is a valid end node at the end of the given path
boolean	isValidEndPoint() Returns true if this node is a valid end point.
void	setEndPointValue(U endPointValue) Sets the end point value for this node
void	setValidEndPoint(boolean validEndPoint) Sets whether or not this is a valid end point
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleTrie

public SimpleTrie()

Creates a new trie

Method Detail

addChild

@SafeVarargs
public final void addChild(@NotNull
                                         T... elements)

Adds a child along the given path, and marks the last element node as a valid end point

Parameters:

elements - The elements along the path

addChild

public final void addChild(@NotNull
                           java.util.List<T> path)

Adds a child along the given path, and marks the last element node as a valid end point

Parameters:

path - The elements along the path

hasChild

@SafeVarargs
public final boolean hasChild(@NotNull
                                            T... elements)

Checks if there is a child node by following the given path

Parameters:

elements - The elements in the path (if empty is given return true as this is the current element which obviously exists)

Returns:

True if there is a child on the given path, false otherwise

hasValidEndPoint

@SafeVarargs
public final boolean hasValidEndPoint(@NotNull
                                                    T... elements)

Checks if there is a valid end node at the end of the given path

Parameters:

elements - The elements in the path (if empty is given return true as this is the current element which obviously exists)

Returns:

True if the path points to a valid end point node, false otherwise

hasValidEndPoint

public boolean hasValidEndPoint(@NotNull
                                java.util.List<T> path)

Checks if there is a valid end node at the end of the given path

Parameters:

path - The elements in the path (if empty is given return true as this is the current element which obviously exists)

Returns:

True if the path points to a valid end point node, false otherwise

setValidEndPoint

public void setValidEndPoint(boolean validEndPoint)

Sets whether or not this is a valid end point

Parameters:

validEndPoint - True if this is a valid end point, false otherwise

isValidEndPoint

public boolean isValidEndPoint()

Returns true if this node is a valid end point. That doesn't mean it has no children, but rather indicates it was a value that was explicitly added

Returns:

True if this node is a valid end point. That doesn't mean it has no children, but rather indicates it was a value that was explicitly added

setEndPointValue

public void setEndPointValue(@Nullable
                             U endPointValue)

Sets the end point value for this node

Parameters:

endPointValue - The end point value for this node

getEndPointValue

@Nullable
public U getEndPointValue()

Returns the end-point value for this node, regardless of if it's a valid end point.

Returns:

The end-point value for this node, regardless of if it's a valid end point.

getChild

@SafeVarargs
 @Nullable
public final SimpleTrie<T,U> getChild(@NotNull
                                                                T... elements)

Gets the child at the end of the given path (or null if there is no such element)

Parameters:

elements - The path to follow

Returns:

The child at the end of the path, or null if there isn't one

getChild

@Nullable
public SimpleTrie<T,U> getChild(@NotNull
                                           java.util.List<T> path)

Gets the child at the end of the given path (or null if there is no such element)

Parameters:

path - The path to follow

Returns:

The child at the end of the path, or null if there isn't one

getChildren

public java.util.Map<T,SimpleTrie<T,U>> getChildren()

Returns the child map for this level of the trie. Modify this map WILL modify the internal trie as well

Returns:

The child map for this level of the trie. Modify this map WILL modify the internal trie as well

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object otherObject)

Overrides:

equals in class java.lang.Object