Package com.aquima.interactions.spellengine

Interface ISpeller

All Superinterfaces:

Serializable

All Known Implementing Classes:

Speller

public interface ISpeller
extends Serializable

Interface description of a speller. A speller converts an integer to its textual representation.

Since:

6.0

Author:

Jon van Leuven

Method Summary

Modifier and Type	Method	Description
String	getDescription()	This method return the description of the speller.
String	getName()	This method return the name of the speller.
String	spell(long integer)	This method returns a textual representation of the passed integer.

Method Details

spell

String spell(long integer)

This method returns a textual representation of the passed integer.

Parameters:

integer - long to use

Returns:

Textual representation of the integer

Throws:

SpellerException - Is thrown when the integer could not be spelled.

getName

String getName()

This method return the name of the speller.

Returns:

the name of the speller (never null)

getDescription

String getDescription()

This method return the description of the speller.

Returns:

the description of the speller, may be null