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/IHand.html | 156 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 146 insertions(+), 10 deletions(-) (limited to 'doc/jrummikub/model/IHand.html') diff --git a/doc/jrummikub/model/IHand.html b/doc/jrummikub/model/IHand.html index 293f9ad..3c8ea74 100644 --- a/doc/jrummikub/model/IHand.html +++ b/doc/jrummikub/model/IHand.html @@ -2,12 +2,12 @@ - + IHand - + @@ -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 @@ -92,7 +92,7 @@ jrummikub.model
Interface IHand
-
All Superinterfaces:
java.lang.Cloneable, IStoneTray<Stone>, java.lang.Iterable<Pair<Stone,Position>>
+
All Superinterfaces:
java.lang.Cloneable, IStoneTray<Stone>, java.lang.Iterable<Pair<Stone,Position>>, java.io.Serializable
All Known Implementing Classes:
Hand
@@ -119,6 +119,47 @@ Interface for the Method Summary + + + int +getFreeRowSpace(int row) + +
+          Gets the amount of free space in a hand row + + + + int +getIdenticalStoneCount() + +
+          Counts the pairs of identical stones + + + + int +getRowCount() + +
+          The number of used rows + + + + int +getStonePoints(GameSettings settings) + +
+          Get the accumulated number of points of stones in the hand + + + + boolean +isInitialMeldPossible(GameSettings settings) + +
+          Tests whether it is possible to lay down an initial meld using the stones + on the hand +   @@ -126,7 +167,7 @@ Interface for the Methods inherited from interface jrummikub.model.IStoneTray - +
clone, drop, getPosition, getSize, pickUpclone, contains, drop, getPosition, getSize, pickUp
  @@ -140,6 +181,101 @@ Interface for the + + + + +
+Method Detail
+ +

+getRowCount

+
+int getRowCount()
+
+
The number of used rows +

+

+
+
+
+ +
Returns:
the number of rows
+
+
+
+ +

+getFreeRowSpace

+
+int getFreeRowSpace(int row)
+
+
Gets the amount of free space in a hand row +

+

+
+
+
+
Parameters:
row - the row number +
Returns:
the number of stones that can fit into the row
+
+
+
+ +

+getStonePoints

+
+int getStonePoints(GameSettings settings)
+
+
Get the accumulated number of points of stones in the hand +

+

+
+
+
+
Parameters:
settings - the game settings +
Returns:
points
+
+
+
+ +

+isInitialMeldPossible

+
+boolean isInitialMeldPossible(GameSettings settings)
+
+
Tests whether it is possible to lay down an initial meld using the stones + on the hand +

+

+
+
+
+
Parameters:
settings - the game settings +
Returns:
true if an initial meld is possible
+
+
+
+ +

+getIdenticalStoneCount

+
+int getIdenticalStoneCount()
+
+
Counts the pairs of identical stones +

+

+
+
+
+ +
Returns:
number of identical stone pairs
+
+
@@ -171,7 +307,7 @@ Interface for the - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -192,9 +328,9 @@ Interface for the - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD -- cgit v1.2.3