GameMaster

java.lang.Object
- wcg.games.ObservableGame
- - wcg.games.GameMaster

Direct Known Subclasses:

HeartsGameMaster, WarGameMaster
```
public abstract class GameMaster
extends ObservableGame
```
Abstract class common to all game masters. A game master is an object to manage a particular kind of game. For example, a HEARTS game is managed by an instance of HeartsGameMaster, which is a specialization of this class. It provides core features such as:
- preparing deck of cards (shuffling);
- sending initial hand to players;
- receive played cards;
- updating round information (cards on table, round);
- keeping points
- etc.
Author:

José Paulo Leal jpleal@fc.up.pt

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class GameMaster.GameStage
Enumeration representing the stages of the game.

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`GameMaster.GameStage` Enumeration representing the stages of the game.

Field Summary

Fields
Modifier and Type Field and Description

(package private) static java.util.Map<java.lang.String,java.lang.Integer> COUNTER

Fields
Modifier and Type	Field and Description
`(package private) static java.util.Map<java.lang.String,java.lang.Integer>`	`COUNTER`

Constructor Summary

Constructors
Modifier Constructor and Description

protected GameMaster()
Create a game and assign it an id.

Constructors
Modifier	Constructor and Description
`protected`	`GameMaster()` Create a game and assign it an id.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptsPlayers()` Is this game still accepting players?
`void`	`addPlayer(Player player)` Adds given player to this game.
`protected abstract void`	`beforeRoundConclusion()` This method is invoked before concluding the round, after all players have played.
`protected abstract void`	`checkCards(java.lang.String nick, java.util.List<Card> cards)` Check if these cards can be played at this moment.
`(package private) void`	`concludeRound()` Conclude round by broadcasting the conclusion event, updating points for all players, setting turn for the next round
`(package private) void`	`dealCards()` Deal cards to each player, set turn (if needed) and notify all players
`boolean`	`expired()` Has this game expired? I.e.
`protected CardComparator`	`getCardComparator()` The card comparator used in this game.
`protected abstract GamePlayingStrategy`	`getCardGameStrategy()` A game playing strategy for this kind of game.
`protected Card`	`getCardOnTable(java.lang.String nick)` Convenience method to retrieve the single card on table of player with given nick.
`protected CardCollection`	`getCardsOnTable(java.lang.String nick)` Retrieve cards on table of player with given nick.
`protected abstract int`	`getCardsPerPlayer()` Number of cards each player receives at the start
`protected CardCollection`	`getDeck()` The deck of cards used by this game, backed by the defined card comparator.
`static long`	`getExpirationtime()` Time in milliseconds for a game to expire.
`java.lang.String`	`getGameId()` A string to identify this particular game instance.
`protected abstract java.lang.String`	`getGameName()` The name of this kind of game.
`protected CardCollection`	`getHand(java.lang.String nick)` Get a cards in given player's hand.
`GameInfo`	`getInfo()` Information describing this game.
`protected java.lang.String`	`getMode()` Retrieve current game mode.
`protected java.lang.String`	`getNickWithTurn()` The nick of the player currently with the turn to play.
`protected abstract int`	`getNumberOfPlayers()` Number of players in this game.
`protected java.util.List<java.lang.String>`	`getPlayerNicks()` A list with the nicks of players in this game.
`protected abstract int`	`getRoundPoints(java.lang.String nick)` Points collected by the player with given nick in the last round.
`protected int`	`getRoundsCompleted()` Number of rounds completed in this game.
`CardSuit`	`getSuitToFollow()` Convenience method with suit to follow: the suit of the first card played in this round.
`protected abstract java.lang.String`	`getWinner()` Who is the winner of this game? This method is invoked if game `hasEnded()`.
`protected abstract boolean`	`hasEnded()` Has this games ended?
`protected abstract java.lang.String`	`initialTurnInRound()` In turn based games, provides the nick of the player player to play in the next round.
`protected abstract boolean`	`isWithTurns()` Do players play in turn, one after the other, in the order they were given in the constructor? Or can they play in any order?
`(package private) java.lang.String`	`makeGameId()` Generate a string id for a game instance using the game name as prefix and a counter.
`protected CardCollection`	`newCardCollection()` Convenience method to create a new empty card collection backed by the this games's `CardComparator`.
`(package private) java.lang.String`	`nextInTurn()` Return the next nick in the list of players.
`protected java.lang.String`	`nickWithMostPoints()` Nick of player with most points, usually the winner.
`void`	`playCard(java.lang.String nick, Card card)` Convenience method to play a single card.
`void`	`playCards(java.lang.String nick, java.util.List<Card> cards)` Play your cards.
`protected void`	`sendCards(java.lang.String nick, CardCollection cards)` Send to player with the given nick the given card collection.
`static void`	`setExpirationtime(long expirationTime)` Change time in milliseconds for a game to expire.
`protected void`	`setMode(java.lang.String mode)` Change current game mode.
`protected abstract void`	`startGame()` Method invoked when all players joined the game.
`(package private) void`	`startPlaying()` Start playing this game: change stage to PLAYING, start the game and update players.

Methods inherited from class wcg.games.ObservableGame
addObserver, broadcast, broadcast, broadcast, notify

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COUNTER
```
static final java.util.Map<java.lang.String,java.lang.Integer> COUNTER
```
- Constructor Detail
  - GameMaster
```
protected GameMaster()
```
    Create a game and assign it an id.
- Method Detail
  - getExpirationtime
```
public static long getExpirationtime()
```
    Time in milliseconds for a game to expire. Default is 10 minutes.
    
    Returns:
    
    the expiration time.
  - setExpirationtime
```
public static void setExpirationtime(long expirationTime)
```
    Change time in milliseconds for a game to expire. Default is 10 minutes. Non positive values make games expire immediately.
    
    Parameters:
    
    expirationTime - to set.
  - getGameId
```
public java.lang.String getGameId()
```
    A string to identify this particular game instance. It must always return the same value and it must uniquely identify the instance. That is, distinct game instances have different IDs.
    
    Returns:
    
    id of this game.
  - getInfo
```
public final GameInfo getInfo()
```
    Information describing this game.
    
    Returns:
    
    info on game.
  - expired
```
public final boolean expired()
```
    Has this game expired? I.e. the difference between the current time and the last access (add a player or play cards) is greater than the the defined expiration time?
    
    Returns:
    
    true if expired; false otherwise.
  - getCardComparator
```
protected CardComparator getCardComparator()
```
    The card comparator used in this game. The class defined the DefaultCardComparator but may be redefined by concrete game rules.
    
    Returns:
    
    comparator used in this collection.
  - getDeck
```
protected CardCollection getDeck()
```
    The deck of cards used by this game, backed by the defined card comparator. The default implementation uses CardCollection.getDeck() but concrete game rules may redefine this method to remove some card values, add other cards such as jokers, or use a double deck.
    
    Returns:
    
    collection of cards to use in this game
  - acceptsPlayers
```
public boolean acceptsPlayers()
```
    Is this game still accepting players?
    
    Returns:
    
    true if accepting, false otherwise
  - addPlayer
```
public final void addPlayer(Player player)
                     throws CardGameException
```
    Adds given player to this game. If the final number of players is reached then game starts
    
    Parameters:
    
    player - to add.
    
    Throws:
    
    CardGameException - if not in preparing stage or if player already in game.
  - startPlaying
```
final void startPlaying()
```
    Start playing this game: change stage to PLAYING, start the game and update players.
  - dealCards
```
final void dealCards()
```
    Deal cards to each player, set turn (if needed) and notify all players
  - sendCards
```
protected final void sendCards(java.lang.String nick,
                               CardCollection cards)
```
    Send to player with the given nick the given card collection. These cards are recorded as part of the player's hand to later verify if played cards correspond to those (s)he/it is holding.
    
    Parameters:
    
    nick - of player.
    
    cards - to send.
  - playCard
```
public final void playCard(java.lang.String nick,
                           Card card)
                    throws CardGameException
```
    Convenience method to play a single card. In general players may play several cards at once, but many trick-taking games only allow a single card per trick (round), in the players turn. This method delegates in playCards(String, List).
    
    Parameters:
    
    nick - of player.
    
    card - to be played.
    
    Throws:
    
    CardGameException - if some game rule is violated.
  - playCards
```
public final void playCards(java.lang.String nick,
                            java.util.List<Card> cards)
                     throws CardGameException
```
    Play your cards. It may be more than one card if this is allowed by the game rules. This method checks if this is cards violate game rules. These may cover
    - is this game in the playing stage?
    - is this the player's turn? (some games don't have turns)
    - were these cards on the player's hand?
    - is it allowed to play these cards at this moment?
    Parameters:
    
    nick - of player.
    
    cards - to be played.
    
    Throws:
    
    CardGameException - if some game rule is violated
    
    Implementation Note:
    
    this method must be synchronized to disable that more than one thread (e.g. bots) to play simultaneously and corrupt the game master's state.
  - nextInTurn
```
java.lang.String nextInTurn()
```
    Return the next nick in the list of players. If the turn was on the the last player on the list, the next will be the first one.
    
    Returns:
    
    nick of player to play next
  - concludeRound
```
void concludeRound()
```
    Conclude round by broadcasting the conclusion event, updating points for all players, setting turn for the next round
  - newCardCollection
```
protected CardCollection newCardCollection()
```
    Convenience method to create a new empty card collection backed by the this games's CardComparator.
    
    Returns:
    
    collection
  - getPlayerNicks
```
protected java.util.List<java.lang.String> getPlayerNicks()
```
    A list with the nicks of players in this game.
    
    Returns:
    
    list with nicks
  - getNickWithTurn
```
protected java.lang.String getNickWithTurn()
```
    The nick of the player currently with the turn to play.
    
    Returns:
    
    nick with turn.
  - getMode
```
protected java.lang.String getMode()
```
    Retrieve current game mode.
    
    Returns:
    
    mode.
  - setMode
```
protected void setMode(java.lang.String mode)
```
    Change current game mode.
    
    Parameters:
    
    mode - to set.
  - getHand
```
protected CardCollection getHand(java.lang.String nick)
```
    Get a cards in given player's hand.
    
    Parameters:
    
    nick - holding cards.
    
    Returns:
    
    cards.
  - getCardsOnTable
```
protected CardCollection getCardsOnTable(java.lang.String nick)
```
    Retrieve cards on table of player with given nick.
    
    Parameters:
    
    nick - of player.
    
    Returns:
    
    card colection
  - getCardOnTable
```
protected Card getCardOnTable(java.lang.String nick)
```
    Convenience method to retrieve the single card on table of player with given nick.
    
    Parameters:
    
    nick - of player
    
    Returns:
    
    card
  - getSuitToFollow
```
public CardSuit getSuitToFollow()
```
    Convenience method with suit to follow: the suit of the first card played in this round. May be null if there are no cards on the table.
    
    Returns:
    
    suit or null.
  - getRoundsCompleted
```
protected int getRoundsCompleted()
```
    Number of rounds completed in this game. Its 0 when the game starts.
    
    Returns:
    
    rounds
  - nickWithMostPoints
```
protected java.lang.String nickWithMostPoints()
```
    Nick of player with most points, usually the winner.
    
    Returns:
    
    winner
  - getCardGameStrategy
```
protected abstract GamePlayingStrategy getCardGameStrategy()
```
    A game playing strategy for this kind of game. This method can return different playing strategies.
    
    Returns:
    
    automatic player.
  - getGameName
```
protected abstract java.lang.String getGameName()
```
    The name of this kind of game. The name should be the same used by the game factory and all in capitals (e.g. HEARTS).
    
    Returns:
    
    name of game.
  - getNumberOfPlayers
```
protected abstract int getNumberOfPlayers()
```
    Number of players in this game.
    
    Returns:
    
    number of players.
  - getCardsPerPlayer
```
protected abstract int getCardsPerPlayer()
```
    Number of cards each player receives at the start
    
    Returns:
    
    number of cards.
  - isWithTurns
```
protected abstract boolean isWithTurns()
```
    Do players play in turn, one after the other, in the order they were given in the constructor? Or can they play in any order?
    
    Returns:
    
    true if game is with turns; false otherwise.
  - startGame
```
protected abstract void startGame()
```
    Method invoked when all players joined the game.
  - checkCards
```
protected abstract void checkCards(java.lang.String nick,
                                   java.util.List<Card> cards)
                            throws CardGameException
```
    Check if these cards can be played at this moment. Throw an exception if a game specific rule was violated. General rules such as playing in turn, playing cards in hand, are already covered and don't need to be addressed.
    
    Parameters:
    
    nick - of player.
    
    cards - to check.
    
    Throws:
    
    CardGameException - if a rule was violated.
  - beforeRoundConclusion
```
protected abstract void beforeRoundConclusion()
```
    This method is invoked before concluding the round, after all players have played.
  - getRoundPoints
```
protected abstract int getRoundPoints(java.lang.String nick)
```
    Points collected by the player with given nick in the last round. This method is invoked after the round is concluded.
    
    Parameters:
    
    nick - of player.
    
    Returns:
    
    points in round.
  - initialTurnInRound
```
protected abstract java.lang.String initialTurnInRound()
```
    In turn based games, provides the nick of the player player to play in the next round. Other players play in a predefined order
    
    Returns:
    
    nick of first player in round
  - hasEnded
```
protected abstract boolean hasEnded()
```
    Has this games ended?
    
    Returns:
    
    true if game ended; false otherwise.
  - getWinner
```
protected abstract java.lang.String getWinner()
```
    Who is the winner of this game? This method is invoked if game hasEnded().
    
    Returns:
    
    nick of winner
  - makeGameId
```
java.lang.String makeGameId()
```
    Generate a string id for a game instance using the game name as prefix and a counter. This method must be invoked only once during instantiation.
    
    Returns:
    
    id of this game instance.

Class GameMaster

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class wcg.games.ObservableGame

Methods inherited from class java.lang.Object

Field Detail

COUNTER

Constructor Detail

GameMaster

Method Detail

getExpirationtime

setExpirationtime

getGameId

getInfo

expired

getCardComparator

getDeck

acceptsPlayers

addPlayer

startPlaying

dealCards

sendCards

playCard

playCards

nextInTurn

concludeRound

newCardCollection

getPlayerNicks

getNickWithTurn

getMode

setMode

getHand

getCardsOnTable

getCardOnTable

getSuitToFollow

getRoundsCompleted

nickWithMostPoints

getCardGameStrategy

getGameName

getNumberOfPlayers

getCardsPerPlayer

isWithTurns

startGame

checkCards

beforeRoundConclusion

getRoundPoints

initialTurnInRound

hasEnded

getWinner

makeGameId