com.putable.common.matrix

Class SayFunction

java.lang.Object

com.putable.common.matrix.SayFunction

public abstract class SayFunction
extends java.lang.Object

A class to represent the functionality of a clickable NetPuzlObject

Version:

1.0

Author:

Heineken

Field Summary

Fields

Modifier and Type	Field and Description
private Key	key The Key to be spoken to, or null if none
private Matrix	matrix The Matrix to be spoken to, or null if none
private Agent	sayer The Agent who spoke to the NetPuzlObject
private Token	token The Token to be spoken to, or null if none

Constructor Summary

Constructors

Constructor and Description
SayFunction(Key key) Constructs a SayFunction with the Key to be spoken to
SayFunction(Matrix matrix) Constructs a SayFunction with the Matrix to be spoken to
SayFunction(Token token) Constructs a SayFunction with the Token to be spoken to

Method Summary

Modifier and Type	Method and Description
Key	getKey() Gets the Key to be spoken to
Matrix	getMatrix() Gets the Matrix to be spoken to
Agent	getSayer() Gets the Agent who spoke to the NetPuzlObject
Token	getToken() Gets the Token to be spoken to
abstract void	say(java.lang.String text) Each NetPuzlObject will have its own action to perform when spoken to
void	setKey(Key key) Sets the Key to be spoken to
void	setMatrix(Matrix matrix) Sets the Matrix to be spoken to
void	setSayer(Agent sayer) Sets the Agent who spoke to the NetPuzlObject
void	setToken(Token token) Sets the Token to be spoken to

Methods inherited from class java.lang.Object

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

Field Detail

key

private Key key

The Key to be spoken to, or null if none

matrix

private Matrix matrix

The Matrix to be spoken to, or null if none

token

private Token token

The Token to be spoken to, or null if none

sayer

private Agent sayer

The Agent who spoke to the NetPuzlObject

Constructor Detail

SayFunction

public SayFunction(Key key)

Constructs a SayFunction with the Key to be spoken to

Parameters:

key - The Key to construct this SayFunction with

SayFunction

public SayFunction(Matrix matrix)

Constructs a SayFunction with the Matrix to be spoken to

Parameters:

matrix - The Matrix to construct this SayFunction with

SayFunction

public SayFunction(Token token)

Constructs a SayFunction with the Token to be spoken to

Parameters:

token - The Token to construct this SayFunction with

Method Detail

getKey

public Key getKey()

Gets the Key to be spoken to

Returns:

The Key of this SayFunction

getMatrix

public Matrix getMatrix()

Gets the Matrix to be spoken to

Returns:

The Matrix of this SayFunction

getSayer

public Agent getSayer()

Gets the Agent who spoke to the NetPuzlObject

Returns:

The Agent of this SayFunction

getToken

public Token getToken()

Gets the Token to be spoken to

Returns:

The Token of this SayFunction

say

public abstract void say(java.lang.String text)

Each NetPuzlObject will have its own action to perform when spoken to

Parameters:

text - The command spoken to the NetPuzlObject

setKey

public void setKey(Key key)

Sets the Key to be spoken to

Parameters:

key - The Key to set this SayFunction to

setMatrix

public void setMatrix(Matrix matrix)

Sets the Matrix to be spoken to

Parameters:

matrix - The Matrix to set this SayFunction to

setSayer

public void setSayer(Agent sayer)

Sets the Agent who spoke to the NetPuzlObject

Parameters:

sayer - The Agent to set this SayFunction to

setToken

public void setToken(Token token)

Sets the Token to be spoken to

Parameters:

token - The Token to set this SayFunction to