io.nadron.app.impl

Class SimpleGame

java.lang.Object

io.nadron.app.impl.SimpleGame

All Implemented Interfaces:

Game

public class SimpleGame
extends Object
implements Game

Domain object representing a game. This is a convenience implementation of the Game interface so that simple games need not implement their own. Note This implementation will throw exception if any of the setter methods are invoked. All variables are final in this class and expected to be set at object construction.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
private GameCommandInterpreter	gameCommandInterpreter Each game has its own specific commands.
private String	gameName The name of the game.
private Object	id This variable could be used as a database key.

Constructor Summary

Constructors

Constructor and Description
SimpleGame(Object id, String gameName)
SimpleGame(Object id, String gameName, GameCommandInterpreter gameCommandInterpreter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
GameCommandInterpreter	getGameCommandInterpreter() Each game requires a different set of game commands.
String	getGameName() Get the name of the game.
Object	getId() Meant as a database access key.
int	hashCode()
void	setGameCommandInterpreter(GameCommandInterpreter interpreter) Set the interpreter associated with this game.
void	setGameName(String gameName) Set the name of the game.
void	setId(Object id) Meant as a database access key.
Object	unload() Unloads the current game, by closing all sessions.

Methods inherited from class java.lang.Object

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

Field Detail

id

private final Object id

This variable could be used as a database key.

gameName

private final String gameName

The name of the game.

gameCommandInterpreter

private final GameCommandInterpreter gameCommandInterpreter

Each game has its own specific commands. This instance will be used to transform those commands(most probably in the form of bytes) to actual java method calls.

Constructor Detail

SimpleGame

public SimpleGame(Object id,
          String gameName)

SimpleGame

public SimpleGame(Object id,
          String gameName,
          GameCommandInterpreter gameCommandInterpreter)

Method Detail

getId

public Object getId()

Meant as a database access key.

Specified by:

getId in interface Game

Returns:

The unique identifier of this Game.

setId

public void setId(Object id)

Meant as a database access key.

Specified by:

setId in interface Game

Parameters:

id - Set the unique identifier for this game.

getGameName

public String getGameName()

Description copied from interface: Game

Get the name of the game. Preferably should be a unique name.

Specified by:

getGameName in interface Game

Returns:

Returns the name of the game.

setGameName

public void setGameName(String gameName)

Description copied from interface: Game

Set the name of the game. Preferably it should be a unique value.

Specified by:

setGameName in interface Game

Parameters:

gameName - Set the preferably unique game name.

getGameCommandInterpreter

public GameCommandInterpreter getGameCommandInterpreter()

Description copied from interface: Game

Each game requires a different set of game commands. This method will set the interpreter which will convert these commands to method calls.

Specified by:

getGameCommandInterpreter in interface Game

Returns:

The associated GameCommandInterpreter instance.

setGameCommandInterpreter

public void setGameCommandInterpreter(GameCommandInterpreter interpreter)

Description copied from interface: Game

Set the interpreter associated with this game. This method will be used if the creation of the interpreter is outside of the implementing game room instance, say by a Game instance or set by the spring container.

Specified by:

setGameCommandInterpreter in interface Game

Parameters:

interpreter - The interpreter instance to set.

unload

public Object unload()

Description copied from interface: Game

Unloads the current game, by closing all sessions. This will delegate to GameRoom.close()

Specified by:

unload in interface Game

Returns:

In case of Netty Implementation it would return a collection of ChannelFuture object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object