From 51b7fbe822bd9a3804c061f0b844884769d7ddba Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Wed, 6 Jul 2011 16:36:06 +0200 Subject: Javadoc git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172 --- doc/jrummikub/model/GameState.html | 255 ++++++++++++++++++++++++------------- 1 file changed, 170 insertions(+), 85 deletions(-) (limited to 'doc/jrummikub/model/GameState.html') diff --git a/doc/jrummikub/model/GameState.html b/doc/jrummikub/model/GameState.html index b99ddf5..4a9e6ae 100644 --- a/doc/jrummikub/model/GameState.html +++ b/doc/jrummikub/model/GameState.html @@ -2,12 +2,12 @@ - + GameState - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -76,9 +76,9 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD @@ -96,22 +96,65 @@ java.lang.Object extended by jrummikub.model.GameState
-
All Implemented Interfaces:
IGameState
+
All Implemented Interfaces:
java.io.Serializable
-
public class GameState
extends java.lang.Object
implements IGameState
+
public class GameState
extends java.lang.Object
implements java.io.Serializable

-Class managing the overall and momentary GameState +Class that stores information for a game of multiple rounds

+

+
See Also:
Serialized Form

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+private  intfirstRoundFirstPlayer + +
+           
+private  PlayerSettingslastPlayerRedealed + +
+           
+private  java.util.ArrayList<Score>scores + +
+           
+private static longserialVersionUID +
+           
+  @@ -124,7 +167,7 @@ Class managing the overall and momentary GameState GameState()
-          Create a new GameState with an empty table and (currently) 4 new players. +              @@ -138,59 +181,60 @@ Class managing the overall and momentary GameState - IPlayer -getActivePlayer() + Score +getAccumulatedScore()
-          Returns the currently active player +          Calculated the accumulated score over the played rounds - StoneHeap -getGameHeap() + int +getFirstRoundFirstPlayer()
-          Returns the heap of stones to draw from +          Gets the number of the first player of the first round - IPlayer -getNthNextPlayer(int i) + PlayerSettings +getLastPlayerRedealed()
-          Returns the player that would be the active player after i turns +          Returns the player that has redealed last - int -getPlayerCount() + java.util.List<Score> +getScores()
-          Returns the number of players +          Returns the list of players' scores in the rounds played before - ITable -getTable() +private  java.lang.Boolean[] +getWinners(java.lang.Integer[] points, + int[] wins)
-          Get the current Table +          Returns whether players have won  void -nextPlayer() +setFirstRoundFirstPlayer(int firstRoundFirstPlayer)
-          Changes the activePlayer to the next Player in the list +          Sets the number of the first player of the first round  void -setTable(ITable table) +setLastPlayerRedealed(PlayerSettings lastPlayerRedealed)
-          Sets the current Table +          Sets the player that has redealed last   @@ -205,6 +249,55 @@ Class managing the overall and momentary GameState  

+ + + + + + + +
+Field Detail
+ +

+serialVersionUID

+
+private static final long serialVersionUID
+
+
+
See Also:
Constant Field Values
+
+
+ +

+firstRoundFirstPlayer

+
+private int firstRoundFirstPlayer
+
+
+
+
+
+ +

+scores

+
+private java.util.ArrayList<Score> scores
+
+
+
+
+
+ +

+lastPlayerRedealed

+
+private PlayerSettings lastPlayerRedealed
+
+
+
+
+ @@ -220,8 +313,6 @@ GameState 
 public GameState()
-
Create a new GameState with an empty table and (currently) 4 new players. -

@@ -234,126 +325,120 @@ public GameState() -

-getTable

+

+getFirstRoundFirstPlayer

-public ITable getTable()
+public int getFirstRoundFirstPlayer()
-
Description copied from interface: IGameState
-
Get the current Table +
Gets the number of the first player of the first round

-
Specified by:
getTable in interface IGameState
+
-
Returns:
The current Table
+
Returns:
the number of the first player of the first round
-

-setTable

+

+setFirstRoundFirstPlayer

-public void setTable(ITable table)
+public void setFirstRoundFirstPlayer(int firstRoundFirstPlayer)
-
Description copied from interface: IGameState
-
Sets the current Table +
Sets the number of the first player of the first round

-
Specified by:
setTable in interface IGameState
+
-
Parameters:
table - The new Table
+
Parameters:
firstRoundFirstPlayer - the number of the first player of the first round
-

-getPlayerCount

+

+setLastPlayerRedealed

-public int getPlayerCount()
+public void setLastPlayerRedealed(PlayerSettings lastPlayerRedealed)
-
Description copied from interface: IGameState
-
Returns the number of players +
Sets the player that has redealed last

-
Specified by:
getPlayerCount in interface IGameState
+
- -
Returns:
number of players
+
Parameters:
lastPlayerRedealed - the player to set
-

-nextPlayer

+

+getLastPlayerRedealed

-public void nextPlayer()
+public PlayerSettings getLastPlayerRedealed()
-
Description copied from interface: IGameState
-
Changes the activePlayer to the next Player in the list +
Returns the player that has redealed last

-
Specified by:
nextPlayer in interface IGameState
+
-
+ +
Returns:
the player
-

-getNthNextPlayer

+

+getScores

-public IPlayer getNthNextPlayer(int i)
+public java.util.List<Score> getScores()
-
Description copied from interface: IGameState
-
Returns the player that would be the active player after i turns +
Returns the list of players' scores in the rounds played before

-
Specified by:
getNthNextPlayer in interface IGameState
+
-
Parameters:
i - number of turns -
Returns:
player active after i turns
+ +
Returns:
the list of scores
-

-getActivePlayer

+

+getWinners

-public IPlayer getActivePlayer()
+private java.lang.Boolean[] getWinners(java.lang.Integer[] points, + int[] wins)
-
Description copied from interface: IGameState
-
Returns the currently active player +
Returns whether players have won

-
Specified by:
getActivePlayer in interface IGameState
+
- -
Returns:
currently active player
+
Parameters:
points - the player's points
wins - the number of wins per player +
Returns:
whether a player has won
-

-getGameHeap

+

+getAccumulatedScore

-public StoneHeap getGameHeap()
+public Score getAccumulatedScore()
-
Description copied from interface: IGameState
-
Returns the heap of stones to draw from +
Calculated the accumulated score over the played rounds

-
Specified by:
getGameHeap in interface IGameState
+
-
Returns:
heap of stones
+
Returns:
the accumulated score
@@ -387,7 +472,7 @@ public - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -408,9 +493,9 @@ public - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD -- cgit v1.2.3