wcg.main

Class GamePool

java.lang.Object

wcg.main.GamePool

public class GamePool
extends java.lang.Object

Pool of games managed by their ID. Expired games are periodically removed using a timer. Java timers receive a tasks to execute using the Template method design pattern.

Author:

José Paulo Leal jpleal@fc.up.pt

Constructor Summary

Constructors

Constructor and Description
GamePool() Create an instance with a timer to schedule the remotion of expired games.

Method Summary

Modifier and Type	Method and Description
(package private) java.lang.String	createGame(java.lang.String name) Create a game master for the game with given name
(package private) java.util.List<GameInfo>	getAvailableGameInfos() Produces a list with information on games still available to human players
(package private) GameMaster	getGameMaster(java.lang.String gameId) The game master with given id
(package private) java.util.List<java.lang.String>	getGameNames()
(package private) void	removeExpiredGames() Remove all games in this pool that have already expired.
(package private) void	reset() Resets GamePool's fields to enable unit testing on the Manager singleton.

Methods inherited from class java.lang.Object

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

Constructor Detail

GamePool

GamePool()

Create an instance with a timer to schedule the remotion of expired games.

Implementation Note:

use the java.util.Timer.scheduleAtFixedRate() and use as rate the GameMaster.getExpirationtime().

Method Detail

getGameNames

java.util.List<java.lang.String> getGameNames()

createGame

java.lang.String createGame(java.lang.String name)
                     throws CardGameException

Create a game master for the game with given name

Parameters:

name - of game

Returns:

id of game

Throws:

CardGameException - if game is unknown

getGameMaster

GameMaster getGameMaster(java.lang.String gameId)
                  throws CardGameException

The game master with given id

Parameters:

gameId - of intended game

Returns:

game

Throws:

CardGameException - if id is invalid

getAvailableGameInfos

java.util.List<GameInfo> getAvailableGameInfos()

Produces a list with information on games still available to human players

Returns:

list of games

removeExpiredGames

void removeExpiredGames()

Remove all games in this pool that have already expired. This method is regularly called by a timer.

Implementation Note:

When iterating over a collection, to remove a element use the remove() method from the iterator rather than a method from the collection itself. Otherwise, a ConcurrentModificationException may be raised. Use a regular for rather than an extended loop to have access to the iterator instance.

reset

void reset()

Resets GamePool's fields to enable unit testing on the Manager singleton. This method must only be used during testing and shoudn't be public.