com.github.fge.grappa.matchers.trie

Class Trie

java.lang.Object

com.github.fge.grappa.matchers.trie.Trie

@Immutable
@Beta
public final class Trie
extends Object

"User-facing" class of a TrieMatcher

This is an implementation of trie designed to search for string constants.

It is a rather "naïve" implementation in that it is only a trie and not a much more sophisticated radix tree, but it is efficient enough that searching for a string among a series of strings is very fast.

The core of the trie search algorithm is implemented by TrieNode.

Since:

1.0.0-beta.6

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxLength() Get the maximum length of a match
int	getNrWords() Get the number of words injected into this trie
static TrieBuilder	newBuilder() Create a new builder for this class
int	search(String needle, boolean ignoreCase) Search for a string into this trie

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static TrieBuilder newBuilder()

Create a new builder for this class

Returns:

a builder

getNrWords

public int getNrWords()

Get the number of words injected into this trie

Returns:

the number of words

getMaxLength

public int getMaxLength()

Get the maximum length of a match

Returns:

the length of the longest word(s) added to this trie

search

public int search(String needle,
         boolean ignoreCase)

Search for a string into this trie

Parameters:

needle - the string to search

Returns:

the length of the match (ie, the string) or -1 if not found