org.passay.dictionary

Class WordListDictionary

java.lang.Object

org.passay.dictionary.WordListDictionary

All Implemented Interfaces:

Dictionary

public class WordListDictionary
extends Object
implements Dictionary

Provides fast searching for dictionary words using a word list. It's critical that the word list provided to this dictionary be sorted according to the natural ordering of String.

Author:

Middleware Services

Field Summary

Fields

Modifier and Type	Field and Description
protected WordList	wordList list used for searching.

Constructor Summary

Constructors

Constructor and Description
WordListDictionary(WordList wl) Creates a new dictionary instance from the supplied WordList.

Method Summary

Modifier and Type	Method and Description
WordList	getWordList() Returns the word list used for searching.
static void	main(String[] args) Provides command line access to this word list dictionary.
boolean	search(String word) Returns whether the supplied word exists in the dictionary.
long	size() Returns the number of words in this dictionary
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

wordList

protected final WordList wordList

list used for searching.

Constructor Detail

WordListDictionary

public WordListDictionary(WordList wl)

Creates a new dictionary instance from the supplied WordList.

Parameters:

wl - list of words sorted according to WordList.getComparator().

NOTE Failure to provide a sorted word list will produce incorrect results.

Method Detail

getWordList

public WordList getWordList()

Returns the word list used for searching.

Returns:

word list

size

public long size()

Description copied from interface: Dictionary

Returns the number of words in this dictionary

Specified by:

size in interface Dictionary

Returns:

total number of words to search

search

public boolean search(String word)

Description copied from interface: Dictionary

Returns whether the supplied word exists in the dictionary.

Specified by:

search in interface Dictionary

Parameters:

word - to search for

Returns:

whether word was found

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)
                 throws Exception

Provides command line access to this word list dictionary.

Parameters:

args - command line arguments

Throws:

Exception - if an error occurs