SpellDictionary (jmyspell-core 1.0-jitsi-1 API)

All Known Implementing Classes:

OpenOfficeSpellDictionary
```
public interface SpellDictionary
```
An interface for all dictionary implementations. It defines the most basic operations on a dictionary: adding words, checking if a word is correct, and getting a list of suggestions for misspelled words.

Author:

DreamTangerine

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addProgressListener(ProgressListener listener)` Add a listener to monitor dictionary load.
`void`	`addWord(String word)` Add a word permanently to the dictionary.
`Locale`	`getLocale()` The locale for what this dictionary is for.
`List<String>`	`getSuggestions(String word)` Returns a list of String that are the suggestions to any word.
`List<String>`	`getSuggestions(String word, int nMax)` Returns a list of String that are the suggestions to any word.
`boolean`	`isCorrect(String word)` Returns true if the word is correctly spelled against the dictionary.
`boolean`	`isLoad()`
`void`	`load()`
`void`	`removeProgressListener(ProgressListener listener)` Remove a listener to monitor dictionary load

- Method Detail
  - addWord
```
void addWord(String word)
      throws SpellDictionaryException
```
    Add a word permanently to the dictionary. In general, to the personal dictionary associated with this main dictionary.
    
    Parameters:
    
    word - a word to add.
    
    Throws:
    
    SpellDictionaryException
  - isCorrect
```
boolean isCorrect(String word)
```
    Returns true if the word is correctly spelled against the dictionary.
    
    Parameters:
    
    word - a word to check.
  - getSuggestions
```
List<String> getSuggestions(String word)
```
    Returns a list of String that are the suggestions to any word. If the word is correctly spelled, then this method could return just that one word, or it could still return a list of words with similar spellings.
    
    Parameters:
    
    word - the word that we want to get a list of spelling suggestions for.
    
    Returns:
    
    List a List of suggested words. It can't be null. An empty list must be return no suggestions.
  - getSuggestions
```
List<String> getSuggestions(String word,
                            int nMax)
```
    Returns a list of String that are the suggestions to any word. If the word is correctly spelled, then this method could return just that one word, or it could still return a list of words with similar spellings.
    
    Parameters:
    
    word - the word that we want to get a list of spelling suggestions for.
    
    nMax - the maximun number of word to return
    
    Returns:
    
    List a List of suggested words. It can't be null. An empty list must be return no suggestions.
  - getLocale
```
Locale getLocale()
```
    The locale for what this dictionary is for.
    
    Returns:
    
    the locale for this dictionary.
  - isLoad
```
boolean isLoad()
```
    Returns:
    
    if dictionary is load and ready to use.
  - load
```
void load()
   throws IOException
```
    Throws:
    
    IOException
  - addProgressListener
```
void addProgressListener(ProgressListener listener)
```
    Add a listener to monitor dictionary load.
    
    Parameters:
    
    listener - the listener to add
  - removeProgressListener
```
void removeProgressListener(ProgressListener listener)
```
    Remove a listener to monitor dictionary load
    
    Parameters:
    
    listener -

Interface SpellDictionary

Method Summary

Method Detail

addWord

isCorrect

getSuggestions

getSuggestions

getLocale

isLoad

load

addProgressListener

removeProgressListener