org.leialearns.logic.interaction

Interface Symbol

All Superinterfaces:

Comparable<Symbol>, HasDescriptionLength

public interface Symbol
extends Comparable<Symbol>, HasDescriptionLength

Defines the unit of communication.

A symbol is a fixed object: its properties do not change.

See Also:

Alphabet

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Symbol.Iterable Represents a NearIterable that returns symbol items.

Method Summary

Methods

Modifier and Type	Method and Description
DirectedSymbol	createDirectedSymbol(Direction direction) Creates a directed symbol that corresponds to the given direction and this symbol.
Alphabet	getAlphabet() Returns the alphabet that contains this symbol.
String	getDenotation() Returns the string that denotes this symbol.
long	getOrdinal() Returns the ordinal number of this symbol within the containing alphabet.
String	toShortString() Returns a short string that denotes this symbol.
String	toShortString(Direction direction) Returns a short string that denotes this symbol together with (normally preceded by) the denotation of the given direction.
String	toString(Direction direction) Returns the string that denotes this symbol together with (normally preceded by) the denotation of the given direction.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.leialearns.logic.utilities.HasDescriptionLength

descriptionLength

Method Detail

getAlphabet

Alphabet getAlphabet()

Returns the alphabet that contains this symbol.

Returns:

The alphabet that contains this symbol

getOrdinal

long getOrdinal()

Returns the ordinal number of this symbol within the containing alphabet. Typically ordinal numbers are assigned in order of the moment that the symbols are added to their alphabet.

Returns:

The ordinal number of this symbol within the containing alphabet

getDenotation

String getDenotation()

Returns the string that denotes this symbol.

Returns:

The string that denotes this symbol

toString

String toString(Direction direction)

Returns the string that denotes this symbol together with (normally preceded by) the denotation of the given direction.

Parameters:

direction - The direction to show with this symbol

Returns:

The denotation of direction and symbol

toShortString

String toShortString()

Returns a short string that denotes this symbol.

Returns:

A short string that denotes this symbol

toShortString

String toShortString(Direction direction)

Returns a short string that denotes this symbol together with (normally preceded by) the denotation of the given direction.

Parameters:

direction - The direction to show with this symbol

Returns:

A short string that shows the direction and this symbol

createDirectedSymbol

DirectedSymbol createDirectedSymbol(Direction direction)

Creates a directed symbol that corresponds to the given direction and this symbol.

Parameters:

direction - The direction to use

Returns:

The directed symbol