* @since 3.0
*/
public interface ISpellDictionary {
-
+
/**
* Returns whether this dictionary accepts new words.
*
- * @return <code>true</code> if this dictionary accepts new words, <code>false</code> otherwise
+ * @return <code>true</code> if this dictionary accepts new words,
+ * <code>false</code> otherwise
*/
public boolean acceptsWords();
* Externalizes the specified word.
*
* @param word
- * The word to externalize in the dictionary
+ * The word to externalize in the dictionary
*/
public void addWord(String word);
* Returns the ranked word proposals for an incorrectly spelled word.
*
* @param word
- * The word to retrieve the proposals for
+ * The word to retrieve the proposals for
* @param sentence
- * <code>true</code> iff the proposals start a new sentence,
- * <code>false</code> otherwise
+ * <code>true</code> iff the proposals start a new sentence,
+ * <code>false</code> otherwise
* @return Array of ranked word proposals
*/
public Set getProposals(String word, boolean sentence);
* Is the specified word correctly spelled?
*
* @param word
- * The word to spell-check
- * @return <code>true</code> iff this word is correctly spelled, <code>false</code>
- * otherwise.
+ * The word to spell-check
+ * @return <code>true</code> iff this word is correctly spelled,
+ * <code>false</code> otherwise.
*/
public boolean isCorrect(String word);
* Is the dictionary loaded?
*
* @return <code>true</code> iff it is loaded, <code>false</code>
- * otherwise
+ * otherwise
*/
public boolean isLoaded();