com.putable.common.matrix

Class Token

java.lang.Object

com.putable.common.matrix.NetPuzlObject

com.putable.common.matrix.Token

public class Token
extends NetPuzlObject

A Token in a Matrix can be clicked on (or spoken to or heard from)

Version:

1.0

Author:

Heineken

Field Summary

Fields

Modifier and Type	Field and Description
private ClickFunction	clickFunction The function that processes clicks for this Token
private SayFunction	sayFunction The function that processes spoken commands for this Token

Constructor Summary

Constructors

Constructor and Description
Token(ObjID objID, Attributes attributes, java.util.Map<ObjID,NetPuzlObject> cache) Constructs a Token with the given parameters

Method Summary

Modifier and Type	Method and Description
void	doClick() Performs the click on this Token
void	doSpokenCommand(java.lang.String text) Performs the command spoken to this Token
ClickFunction	getClickFunction() Gets the function that processes clicks for this Token
SayFunction	getSayFunction() Gets the function that processes spoken commands for this Token
boolean	hasClick() Determines if this Token has a function to process clicks
boolean	hasSpokenCommand() Determines if this Token has a function to process spoken commands
void	setClickFunction(ClickFunction clickFunction) Sets the function that processes clicks for this Token
void	setSayFunction(SayFunction sayFunction) Sets the function that processes spoken commands for this Token

Methods inherited from class com.putable.common.matrix.NetPuzlObject

createSetTag, fullToString, getAttributes, getObjID, setAttributes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

clickFunction

private ClickFunction clickFunction

The function that processes clicks for this Token

sayFunction

private SayFunction sayFunction

The function that processes spoken commands for this Token

Constructor Detail

Token

public Token(ObjID objID,
             Attributes attributes,
             java.util.Map<ObjID,NetPuzlObject> cache)

Constructs a Token with the given parameters

Parameters:

objID - The object ID to construct this Token with

attributes - The Attributes to construct this Token with

cache - The Map to cache this Token in

Method Detail

doClick

public void doClick()

Performs the click on this Token

doSpokenCommand

public void doSpokenCommand(java.lang.String text)

Performs the command spoken to this Token

Parameters:

text - The command spoken to this Token

getClickFunction

public ClickFunction getClickFunction()

Gets the function that processes clicks for this Token

Returns:

The function that processes clicks for this Token

getSayFunction

public SayFunction getSayFunction()

Gets the function that processes spoken commands for this Token

Returns:

The function that processes spoken commands for this Token

hasClick

public boolean hasClick()

Determines if this Token has a function to process clicks

Returns:

Whether or not this Token has a function to process clicks

hasSpokenCommand

public boolean hasSpokenCommand()

Determines if this Token has a function to process spoken commands

Returns:

Whether or not this Token has a function to process spoken commands

setClickFunction

public void setClickFunction(ClickFunction clickFunction)

Sets the function that processes clicks for this Token

Parameters:

clickFunction - The function that processes clicks to set this Token to

setSayFunction

public void setSayFunction(SayFunction sayFunction)

Sets the function that processes spoken commands for this Token

Parameters:

sayFunction - The function that processes spoken commands to set this Token to