Package com.day.cq.spellchecker.spi

Interface SpellChecker

public interface SpellChecker
Generic spellchecker interface, returned by a spellchecker provider.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    check(String word)
    Check a word against the spellchecker.
    int
    suggest(String word, String[] suggestions)
    Return spelling suggestions for a word.

  • Method Details

    • check

      boolean check(String word)
      Check a word against the spellchecker. Return true if the word is correct, else false
      Parameters:
      word - word to check
      Returns:
      a flag indicating, whether the word is correct

    • suggest

      int suggest(String word, String[] suggestions)
      Return spelling suggestions for a word. Takes a word and an empty suggestion list as arguments. Returns the number of suggestions found and filled into the suggestion list.
      Parameters:
      word - word to find suggestions for
      suggestions - list of suggestions to be filled
      Returns:
      number of suggestions found and filled into the suggestions array