Package com.aquima.interactions.spellengine

Interface ISpellEngine

All Superinterfaces:
Serializable
All Known Implementing Classes:
SpellEngine
public interface ISpellEngine extends Serializable
Interface describing the main methods of the spell engine.
Since:
6.0
Author:
Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    ISpeller
    getSpeller(String spellerName)
    This method returns a speller.
    String[]
    getSpellerNames()
    This method returns the names of all available spellers in the spell engine.

  • Method Details

    • getSpeller

      ISpeller getSpeller(String spellerName)
      This method returns a speller.
      Parameters:
      spellerName - The speller name used for lookup.
      Returns:
      Speller The speller
      Throws:
      UnknownSpellerException - Is thrown when the speller does not exist.

    • getSpellerNames

      String[] getSpellerNames()
      This method returns the names of all available spellers in the spell engine.
      Returns:
      The names of the available spellers, never null