Package com.github.tadukoo.util.dictionary

Interface Dictionary

All Known Implementing Classes:
AbstractDictionary, ISO_LATIN1Dictionary, US_ASCIIDictionary, UTF16BEDictionary, UTF16Dictionary, UTF16LEDictionary, UTF8Dictionary
public interface Dictionary
Dictionary is used to store and retrieve a collection of valid words.
Version:
Alpha v.0.4
Author:
Logan Ferree (Tadukoo)

  • Method Details

    • supportedCharset

      Charset supportedCharset()
      Returns:
      The Charset that this Dictionary supports

    • asMap

      Map<Character,Map<Character,?>> asMap()
      Returns:
      The valid words for this Dictionary in a Map

    • isValidWord

      boolean isValidWord(CharSequence word)
      Parameters:
      word - The word to look for in this Dictionary
      Returns:
      If the given word is in this Dictionary or not

    • addWord

      boolean addWord(CharSequence word)
      Adds the given word to this Dictionary
      Parameters:
      word - The word to be added to this Dictionary
      Returns:
      If the word was added to the Dictionary (or already exists in it)

    • removeWord

      boolean removeWord(CharSequence word)
      Removes the given word from this Dictionary
      Parameters:
      word - The word to be removed from this Dictionary
      Returns:
      true if the word was removed, or false if it wasn't found