Class StringWordTokenizer

java.lang.Object
com.swabunga.spell.event.AbstractWordTokenizer
com.swabunga.spell.event.StringWordTokenizer
All Implemented Interfaces:
WordTokenizer

public class StringWordTokenizer extends AbstractWordTokenizer
This class tokenizes a input string.

It also allows for the string to be altered by calls to replaceWord(). The result after the spell checking is completed is available to the call to getContext.

Author:
Jason Height (jheight@chariot.net.au), Anthony Roy (ajr@antroy.co.uk)
  • Constructor Details

    • StringWordTokenizer

      public StringWordTokenizer(String s)
      Creates a new StringWordTokenizer object.
      Parameters:
      s - the string to tokenize.
    • StringWordTokenizer

      public StringWordTokenizer(WordFinder wf)
      Creates a new StringWordTokenizer object.
      Parameters:
      wf - the custom WordFinder to use in tokenizing. Note that the string to tokenize will be encapsulated within the WordFinder.
    • StringWordTokenizer

      public StringWordTokenizer(String s, WordFinder finder)
      Creates a new StringWordTokenizer object.
      Parameters:
      s - the string to work on
      finder - the custom WordFinder to use in tokenizing. Note that the string to tokenize will be encapsulated within the WordFinder.
  • Method Details

    • getFinalText

      public String getFinalText()
      Deprecated.
      use getContext() instead as per the WordTokenizer interface specification.
      Returns:
      the final text.
    • replaceWord

      public void replaceWord(String s)
      Replace the current word in the iteration with the String s.
      Specified by:
      replaceWord in interface WordTokenizer
      Specified by:
      replaceWord in class AbstractWordTokenizer
      Parameters:
      s - the String to replace the current word.
      Throws:
      WordNotFoundException - current word not yet set.