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/Hand.html | 233 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 218 insertions(+), 15 deletions(-) (limited to 'doc/jrummikub/model/Hand.html') diff --git a/doc/jrummikub/model/Hand.html b/doc/jrummikub/model/Hand.html index 985907a..fdea6c2 100644 --- a/doc/jrummikub/model/Hand.html +++ b/doc/jrummikub/model/Hand.html @@ -2,12 +2,12 @@ - + Hand - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -97,7 +97,7 @@ java.lang.Object extended by jrummikub.model.Hand
-
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<Stone,Position>>, IHand, IStoneTray<Stone>
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Pair<Stone,Position>>, IHand, IStoneTray<Stone>
@@ -109,6 +109,8 @@ Class managing a Serialized Form

@@ -141,11 +143,19 @@ Class managing a -static int -HEIGHT +private static java.util.Comparator<Pair<java.lang.Integer,StoneColor>> +comparator + +
+          The measure to compare the stones by + + + +private static long +serialVersionUID
-          The height of the hand +            @@ -192,6 +202,14 @@ Class managing a +private static Pair<java.util.TreeMap<Pair<java.lang.Integer,StoneColor>,java.lang.Integer>,java.lang.Integer> +countStones(java.util.List<Stone> stones) + +
+          Counts the numbers of stones + + + protected  Pair<Position,StoneTray.Direction> fixInvalidDrop(Stone stone, Position pos, @@ -201,6 +219,56 @@ Class managing a + + 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 + + + +private static void +incrementStoneCount(java.util.TreeMap<Pair<java.lang.Integer,StoneColor>,java.lang.Integer> stones, + Pair<java.lang.Integer,StoneColor> stone) + +
+          Increments the count of a stone in the list of all stones + + + + boolean +isInitialMeldPossible(GameSettings settings) + +
+          Tests whether it is possible to lay down an initial meld using the stones + on the hand +   @@ -208,7 +276,7 @@ Class managing a Methods inherited from class jrummikub.model.StoneTray - +
clone, drop, getPosition, getSize, iterator, pickUpclone, contains, drop, getPosition, getSize, iterator, pickUp
  @@ -226,7 +294,7 @@ Class managing a Methods inherited from interface jrummikub.model.IStoneTray -clone, drop, getPosition, getSize, pickUp +clone, contains, drop, getPosition, getSize, pickUp   @@ -251,6 +319,16 @@ Class managing a

+serialVersionUID

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

WIDTH

@@ -263,15 +341,15 @@ public static final int WIDTH
-

-HEIGHT

+

+comparator

-public static final int HEIGHT
+private static final java.util.Comparator<Pair<java.lang.Integer,StoneColor>> comparator
-
The height of the hand +
The measure to compare the stones by

-
See Also:
Constant Field Values
+
@@ -301,6 +379,42 @@ public Hand() +

+getFreeRowSpace

+
+public int getFreeRowSpace(int row)
+
+
Description copied from interface: IHand
+
Gets the amount of free space in a hand row +

+

+
Specified by:
getFreeRowSpace in interface IHand
+
+
+
Parameters:
row - the row number +
Returns:
the number of stones that can fit into the row
+
+
+
+ +

+getRowCount

+
+public int getRowCount()
+
+
Description copied from interface: IHand
+
The number of used rows +

+

+
Specified by:
getRowCount in interface IHand
+
+
+ +
Returns:
the number of rows
+
+
+
+

fixInvalidDrop

@@ -320,6 +434,95 @@ protected 

+getStonePoints

+
+public int getStonePoints(GameSettings settings)

+

+
Description copied from interface: IHand

+
Get the accumulated number of points of stones in the hand
+

+

+
Specified by:
getStonePoints in interface IHand

+

+

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

+

+

+

+
+

+isInitialMeldPossible

+
+public boolean isInitialMeldPossible(GameSettings settings)

+

+
Description copied from interface: IHand

+
Tests whether it is possible to lay down an initial meld using the stones
+ on the hand
+

+

+
Specified by:
isInitialMeldPossible in interface IHand

+

+

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

+

+

+

+
+

+incrementStoneCount

+
+private static void incrementStoneCount(java.util.TreeMap<Pair<java.lang.Integer,StoneColor>,java.lang.Integer> stones,
+                                        Pair<java.lang.Integer,StoneColor> stone)

+

+
Increments the count of a stone in the list of all stones
+

+

+

+

+

+
Parameters:
stones - all stones and their respective numbers
stone - the start stone

+

+

+

+
+

+countStones

+
+private static Pair<java.util.TreeMap<Pair<java.lang.Integer,StoneColor>,java.lang.Integer>,java.lang.Integer> countStones(java.util.List<Stone> stones)

+

+
Counts the numbers of stones
+

+

+

+

+

+
Parameters:
stones - the stones to count
+
Returns:
the numbers for all stones

+

+

+

+
+

+getIdenticalStoneCount

+
+public int getIdenticalStoneCount()

+

+
Description copied from interface: IHand

+
Counts the pairs of identical stones
+

+

+
Specified by:
getIdenticalStoneCount in interface IHand

+

+

+
+
Returns:
number of identical stone pairs

+

+

 
 

 
@@ -352,7 +555,7 @@ protected 
  PREV CLASS 
- NEXT CLASS
+ NEXT CLASS
 
   FRAMES   
  NO FRAMES   
-- 
cgit v1.2.3