public interface SpellingDictionary
This interface defines methods for a spelling checker dicionary. The interface provides for looking up words in the dictionary and for adding a word to the dictionary.
Modifier and Type | Method and Description |
---|---|
boolean |
addWord(java.lang.String word)
Add a word to the dictionary.
|
boolean |
addWords(java.lang.String[] words)
Add multiple words to the dictionary
|
void |
clear()
Clears the dictionary of all words.
|
java.util.Set<java.lang.String> |
getAllWords()
Retrieves all words in dictionary.
|
int |
getNumberOfWords()
Retrieves number of words in dictionary.
|
java.util.Set<java.lang.String> |
getRelatedWords(java.lang.String key)
Get related words.
|
boolean |
lookupWord(java.lang.String word)
Lookup word in dictionary.
|
boolean lookupWord(java.lang.String word)
word
- The word to lookup.boolean addWord(java.lang.String word)
word
- The word to add to the dictionary.boolean addWords(java.lang.String[] words)
words
- The words to add to the dictionary.java.util.Set<java.lang.String> getRelatedWords(java.lang.String key)
key
- The key for the list of related words.
Typically this is a hash code like a Soundex
or Metaphone value.java.util.Set<java.lang.String> getAllWords()
int getNumberOfWords()
void clear()