io.nadron.service.impl

Class SimpleGameAdminService

java.lang.Object

io.nadron.service.impl.SimpleGameAdminService

All Implemented Interfaces:

GameAdminService

public class SimpleGameAdminService
extends Object
implements GameAdminService

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<Game>	games

Constructor Summary

Constructors

Constructor and Description
SimpleGameAdminService()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Game>	getGames()
Object	loadGame(long gameId, String gameName) Loads a game based on the game id OR game name.
Object	loadGameRoom(Game game, long gameRoomId, String gameRoomName) Loads a game room based on the game room id OR game name.
boolean	registerGame(Game game) Implementation method will internally add this game instance to a set.
void	setGames(Collection<Game> games)
void	shutdown() Unloads all the games and game rooms that is stored in the admin services internal set.
Object	unLoadGame(Game game) Unloads a game based on the game instance passed in.
Object	unLoadGame(long gameId, String gameName) Unloads a game based on the game id OR game name.
Object	unloadGameRoom(Game game, long gameRoomId) Unloads a game room of a game based on the instance of the game, the unique identifier of the game room or the string game room name.
void	unloadGameRoom(GameRoom gameRoom) Unloads a game room based on the game room instance passed in.
Object	unloadGameRoom(Game game, String gameRoomId) Unloads a game room of a game based on the instance of the game and the name of the game room.

Methods inherited from class java.lang.Object

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

Field Detail

games

private Collection<Game> games

Constructor Detail

SimpleGameAdminService

public SimpleGameAdminService()

Method Detail

registerGame

public boolean registerGame(Game game)

Description copied from interface: GameAdminService

Implementation method will internally add this game instance to a set.

Specified by:

registerGame in interface GameAdminService

Parameters:

game - The game instance to register with the admin service.

Returns:

True if addition is successful, false if a duplicate is present in the set.

loadGame

public Object loadGame(long gameId,
              String gameName)

Description copied from interface: GameAdminService

Loads a game based on the game id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game name will be used to retrieve the game.

Specified by:

loadGame in interface GameAdminService

Parameters:

gameId - The unique number identifier for the game. Most probably a database key.

gameName - The unique name for a game.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success or failure.

loadGameRoom

public Object loadGameRoom(Game game,
                  long gameRoomId,
                  String gameRoomName)

Description copied from interface: GameAdminService

Loads a game room based on the game room id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game room name will be used to retrieve the game room.

Specified by:

loadGameRoom in interface GameAdminService

Parameters:

game - The game for which the game room need to be loaded.

gameRoomId - The unique identifier for the game room. Most probably a database id.

gameRoomName - The name of the game room to load.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unLoadGame

public Object unLoadGame(long gameId,
                String gameName)

Description copied from interface: GameAdminService

Unloads a game based on the game id OR game name. The first preference is to id. The id will be ignored if it is a negative number and game name will be used to retrieve the game. Side affect will be the closing of any resources, GameRooms or PlayerSessions associated with this game.

Specified by:

unLoadGame in interface GameAdminService

Parameters:

gameId - The unique number identifier for the game. Most probably a database key.

gameName - The unique name for a game.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unLoadGame

public Object unLoadGame(Game game)

Description copied from interface: GameAdminService

Unloads a game based on the game instance passed in. Since the instance will internally contain the unique id or String name, this method will delegate to the overloaded method which takes id and String. Side affect will be the closing of any resources, GameRooms or PlayerSessions associated with this game.

Specified by:

unLoadGame in interface GameAdminService

Parameters:

game - The instance of the game to unload.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unloadGameRoom

public void unloadGameRoom(GameRoom gameRoom)

Description copied from interface: GameAdminService

Unloads a game room based on the game room instance passed in. Since the instance will internally contain the unique id or String name, this method will delegate to the overloaded method which takes id and String. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Specified by:

unloadGameRoom in interface GameAdminService

Parameters:

gameRoom - The game room instance which is to be unloaded.

unloadGameRoom

public Object unloadGameRoom(Game game,
                    long gameRoomId)

Description copied from interface: GameAdminService

Unloads a game room of a game based on the instance of the game, the unique identifier of the game room or the string game room name. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Specified by:

unloadGameRoom in interface GameAdminService

Parameters:

game - The instance of the game for which the game room needs to be removed.

gameRoomId - The unique identifier for the game room. Most probably a database id.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

unloadGameRoom

public Object unloadGameRoom(Game game,
                    String gameRoomId)

Description copied from interface: GameAdminService

Unloads a game room of a game based on the instance of the game and the name of the game room. Side affect will be the closing of any resources like PlayerSessions associated with this game room.

Specified by:

unloadGameRoom in interface GameAdminService

Parameters:

game - The instance of the game for which the game room needs to be removed

gameRoomId - The name of the game room to unload.

Returns:

Optionally returns an object, if it is an asynchronous operation, then it would return a Future object, otherwise it would return a boolean suggesting success(true) or failure(false).

shutdown

public void shutdown()

Description copied from interface: GameAdminService

Unloads all the games and game rooms that is stored in the admin services internal set.

Specified by:

shutdown in interface GameAdminService

getGames

public Collection<Game> getGames()

setGames

public void setGames(Collection<Game> games)