school/cs240/src/SpellCorrector/SpellCorrector.java

29 lines
826 B
Java

package spell;
import java.io.IOException;
public interface SpellCorrector {
@SuppressWarnings("serial")
public static class NoSimilarWordFoundException extends Exception {
}
/**
* Tells this <code>SpellCorrector</code> to use the given file as its dictionary
* for generating suggestions.
* @param dictionaryFileName File containing the words to be used
* @throws IOException If the file cannot be read
*/
public void useDictionary(String dictionaryFileName) throws IOException;
/**
* Suggest a word from the dictionary that most closely matches
* <code>inputWord</code>
* @param inputWord
* @return The suggestion
* @throws NoSimilarWordFoundException If no similar word is in the dictionary
*/
public String suggestSimilarWord(String inputWord) throws NoSimilarWordFoundException;
}