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/Player.html | 354 +++++++++++++++++++++++++++++++++++----- 1 file changed, 316 insertions(+), 38 deletions(-) (limited to 'doc/jrummikub/model/Player.html') diff --git a/doc/jrummikub/model/Player.html b/doc/jrummikub/model/Player.html index a3f4e3d..d1aa71f 100644 --- a/doc/jrummikub/model/Player.html +++ b/doc/jrummikub/model/Player.html @@ -2,12 +2,12 @@ - + Player - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO 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,7 +96,7 @@ java.lang.Object extended by jrummikub.model.Player
-
All Implemented Interfaces:
IPlayer
+
All Implemented Interfaces:
java.io.Serializable, IPlayer
@@ -108,10 +108,69 @@ Class managing player data. No methods in release 1

+

+
See Also:
Serialized Form

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+private  IHandhand + +
+           
+private  booleanlaidOut + +
+           
+private  booleanlastTurnInvalid + +
+           
+private  intlastTurnStoneCount +
+           
+private static longserialVersionUID + +
+           
+private  PlayerSettingssettings + +
+           
+  @@ -121,8 +180,7 @@ Class managing player data. No methods in release 1 Constructor Summary -Player(java.lang.String name, - java.awt.Color color) +Player(PlayerSettings settings)
          Create a new player with a given name and color @@ -139,27 +197,75 @@ Class managing player data. No methods in release 1 - java.awt.Color -getColor() + IHand +getHand()
-          Return the player's color +          Get the current hand of the player - IHand -getHand() + boolean +getLaidOut()
-          Get the current hand of the player +          Has the player laid out yet? - java.lang.String -getName() + int +getLastTurnStoneCount()
-          Return the name of the player +          Gets the number of stones put on table in player's last turn + + + + PlayerSettings +getPlayerSettings() + +
+          Returns the player settings + + + + void +setHand(IHand hand) + +
+          Set the current hand of the player + + + + void +setLaidOut(boolean laidOut) + +
+          Set if the player laid out + + + + void +setLastTurnInvalid(boolean value) + +
+          Sets last turn invalid + + + + void +setLastTurnStoneCount(int value) + +
+          Sets the number of stones out on the table in player's last turn + + + + boolean +wasLastTurnInvalid() + +
+          Getter for last turn invalid   @@ -174,6 +280,75 @@ Class managing player data. No methods in release 1  

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

+serialVersionUID

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

+settings

+
+private PlayerSettings settings
+
+
+
+
+
+ +

+hand

+
+private IHand hand
+
+
+
+
+
+ +

+laidOut

+
+private boolean laidOut
+
+
+
+
+
+ +

+lastTurnInvalid

+
+private boolean lastTurnInvalid
+
+
+
+
+
+ +

+lastTurnStoneCount

+
+private int lastTurnStoneCount
+
+
+
+
+ @@ -184,16 +359,15 @@ Class managing player data. No methods in release 1 -

+

Player

-public Player(java.lang.String name,
-              java.awt.Color color)
+public Player(PlayerSettings settings)
Create a new player with a given name and color

-
Parameters:
name - player name
color - player's color
+
Parameters:
settings - the player settings
@@ -224,38 +398,142 @@ public

-getColor

+

+setHand

-public java.awt.Color getColor()
+public void setHand(IHand hand)
-
Description copied from interface: IPlayer
-
Return the player's color +
Description copied from interface: IPlayer
+
Set the current hand of the player

-
Specified by:
getColor in interface IPlayer
+
Specified by:
setHand in interface IPlayer
+
Parameters:
hand - the new hand
+
+ +
-
Returns:
the player's color +

+getLaidOut

+
+public boolean getLaidOut()
+
+
Description copied from interface: IPlayer
+
Has the player laid out yet? +

+

+
Specified by:
getLaidOut in interface IPlayer
+
+
+ +
Returns:
if the player has laid out
-

-getName

+

+setLaidOut

-public java.lang.String getName()
+public void setLaidOut(boolean laidOut)
-
Description copied from interface: IPlayer
-
Return the name of the player +
Description copied from interface: IPlayer
+
Set if the player laid out

-
Specified by:
getName in interface IPlayer
+
Specified by:
setLaidOut in interface IPlayer
+
Parameters:
laidOut - the player laid out
+
+ +
-
Returns:
the player's name +

+getPlayerSettings

+
+public PlayerSettings getPlayerSettings()
+
+
Description copied from interface: IPlayer
+
Returns the player settings +

+

+
Specified by:
getPlayerSettings in interface IPlayer
+
+
+ +
Returns:
the player settings
+
+
+
+ +

+wasLastTurnInvalid

+
+public boolean wasLastTurnInvalid()
+
+
Description copied from interface: IPlayer
+
Getter for last turn invalid +

+

+
Specified by:
wasLastTurnInvalid in interface IPlayer
+
+
+ +
Returns:
last turn invalid
+
+
+
+ +

+setLastTurnInvalid

+
+public void setLastTurnInvalid(boolean value)
+
+
Description copied from interface: IPlayer
+
Sets last turn invalid +

+

+
Specified by:
setLastTurnInvalid in interface IPlayer
+
+
+
Parameters:
value - last turn invalid
+
+
+
+ +

+getLastTurnStoneCount

+
+public int getLastTurnStoneCount()
+
+
Description copied from interface: IPlayer
+
Gets the number of stones put on table in player's last turn +

+

+
Specified by:
getLastTurnStoneCount in interface IPlayer
+
+
+ +
Returns:
number of stones
+
+
+
+ +

+setLastTurnStoneCount

+
+public void setLastTurnStoneCount(int value)
+
+
Description copied from interface: IPlayer
+
Sets the number of stones out on the table in player's last turn +

+

+
Specified by:
setLastTurnStoneCount in interface IPlayer
+
+
+
Parameters:
value - number of stones
@@ -290,7 +568,7 @@ public java.lang.String getName()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -310,9 +588,9 @@ public java.lang.String getName() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD -- cgit v1.2.3