at.pwd.boardgame.game.base

Class WinState

java.lang.Object

at.pwd.boardgame.game.base.WinState

public class WinState
extends java.lang.Object

Describes if there is a winner and if there is a winner, who is this winner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WinState.States Enum describing the different states of winning

Constructor Summary

Constructors

Constructor and Description
WinState(WinState.States state, int playerId) Constructor

Method Summary

Modifier and Type	Method and Description
int	getPlayerId() getter for the player ID
WinState.States	getState() getter for the state of winning

Methods inherited from class java.lang.Object

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

Constructor Detail

WinState

public WinState(WinState.States state,
                int playerId)

Constructor

Parameters:

state - What win state is the game currently in?

playerId - Who wins? If nobody is currently winning (or if there are multiple winning then it is a draw) playerId=-1

Method Detail

getPlayerId

public int getPlayerId()

getter for the player ID

Returns:

Returns the winning player (if there is one) or -1

getState

public WinState.States getState()

getter for the state of winning

Returns:

States