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/StoneSet.html | 175 ++++++++++++++++++++++++++++++++------ 1 file changed, 147 insertions(+), 28 deletions(-) (limited to 'doc/jrummikub/model/StoneSet.html') diff --git a/doc/jrummikub/model/StoneSet.html b/doc/jrummikub/model/StoneSet.html index c476ebe..0cf4073 100644 --- a/doc/jrummikub/model/StoneSet.html +++ b/doc/jrummikub/model/StoneSet.html @@ -2,12 +2,12 @@ - + StoneSet - + @@ -96,11 +96,11 @@ java.lang.Object extended by jrummikub.model.StoneSet
-
All Implemented Interfaces:
java.lang.Iterable<Stone>, Sizeable
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<Stone>, Sizeable
-
public class StoneSet
extends java.lang.Object
implements java.lang.Iterable<Stone>, Sizeable
+
public class StoneSet
extends java.lang.Object
implements java.lang.Iterable<Stone>, Sizeable, java.io.Serializable

@@ -108,6 +108,8 @@ Class managing Serialized Form

@@ -141,6 +143,22 @@ Class managing HORIZONTAL_BORDER +
+            + + + +private static long +serialVersionUID + +
+            + + + +private  java.util.ArrayList<Stone> +stones +
            @@ -186,12 +204,21 @@ Class managing - StoneSet.Type -classify() + Pair<StoneSet.Type,java.lang.Integer> +classify(GameSettings settings)
-          Test for rule conflict within the StoneSet and determine whether the set - is a group or a run +          Test for rule conflict within the StoneSet and determine whether the set is + a group or a run + + + +private  Pair<StoneSet.Type,java.lang.Integer> +classifyJokersOnly(GameSettings settings) + +
+          Test for rule conflict within a StoneSet with jokers only and determine + whether the set is a group or a run @@ -211,6 +238,14 @@ Class managing + int +getSize() + +
+          Returns the number of stones in the set. + + +  float getWidth() @@ -220,13 +255,31 @@ Class managing  boolean -isValid() +isValid(GameSettings settings)
          Test for rule conflict within the StoneSet +private  int +isValidGroup(int value, + GameSettings settings) + +
+          Test for rule conflict within the StoneSet, assuming we have a group + + + +private  int +isValidRun(int referencePosition, + GameSettings settings) + +
+          Test for rule conflict within the StoneSet, assuming we have a run + + +  java.util.Iterator<Stone> iterator() @@ -243,14 +296,6 @@ Class managing - int -size() - -
-          Returns the number of stones in the set. - - -  Pair<StoneSet,StoneSet> splitAt(int position) @@ -289,6 +334,16 @@ Class managing

+serialVersionUID

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

VERTICAL_BORDER

@@ -307,6 +362,16 @@ static final float HORIZONTAL_BORDER
See Also:
Constant Field Values
+
+ +

+stones

+
+private java.util.ArrayList<Stone> stones
+
+
+
+
@@ -351,10 +416,10 @@ public StoneSet(java.util.List<

+

isValid

-public boolean isValid()
+public boolean isValid(GameSettings settings)
Test for rule conflict within the StoneSet

@@ -362,26 +427,80 @@ public boolean isValid()

- +
Parameters:
settings - GameSettings
Returns:
true when the set is valid according to the rules
-

+

classify

-public StoneSet.Type classify()
+public Pair<StoneSet.Type,java.lang.Integer> classify(GameSettings settings) +
+
Test for rule conflict within the StoneSet and determine whether the set is + a group or a run +

+

+
+
+
+
Parameters:
settings - GameSettings +
Returns:
GROUP or RUN for valid sets, INVALID otherwise and the points
+
+
+
+ +

+classifyJokersOnly

+
+private Pair<StoneSet.Type,java.lang.Integer> classifyJokersOnly(GameSettings settings)
+
+
Test for rule conflict within a StoneSet with jokers only and determine + whether the set is a group or a run +

+

+
+
+
+
Parameters:
settings - the game settings +
Returns:
GROUP or RUN for valid sets, INVALID otherwise and the points
+
+
+
+ +

+isValidRun

+
+private int isValidRun(int referencePosition,
+                       GameSettings settings)
-
Test for rule conflict within the StoneSet and determine whether the set - is a group or a run +
Test for rule conflict within the StoneSet, assuming we have a run

+
Parameters:
referencePosition - position of stone used as reference (any non-joker stone)
settings - the game settings +
Returns:
the set's points
+
+
+
-
Returns:
GROUP or RUN for valid sets, INVALID otherwise +

+isValidGroup

+
+private int isValidGroup(int value,
+                         GameSettings settings)
+
+
Test for rule conflict within the StoneSet, assuming we have a group +

+

+
+
+
+
Parameters:
value - the value of the stones (all have the same in a group)
settings - the game settings +
Returns:
the set's points
@@ -421,10 +540,10 @@ public

-size

+

+getSize

-public int size()
+public int getSize()
Returns the number of stones in the set.

-- cgit v1.2.3