From 670fcf2613f6db2a4bfdaa91ac9d90001a90359e Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Tue, 10 May 2011 16:59:40 +0200 Subject: docs fertig und vorher repariert git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@232 72836036-5685-4462-b002-a69064685172 --- doc/jrummikub/model/StoneSet.html | 583 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 583 insertions(+) create mode 100644 doc/jrummikub/model/StoneSet.html (limited to 'doc/jrummikub/model/StoneSet.html') diff --git a/doc/jrummikub/model/StoneSet.html b/doc/jrummikub/model/StoneSet.html new file mode 100644 index 0000000..5cf6895 --- /dev/null +++ b/doc/jrummikub/model/StoneSet.html @@ -0,0 +1,583 @@ + + + + + + +StoneSet + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class StoneSet

+
+java.lang.Object
+  extended by jrummikub.model.StoneSet
+
+
+
All Implemented Interfaces:
java.lang.Iterable<Stone>, Sizeable
+
+
+
+
public class StoneSet
extends java.lang.Object
implements java.lang.Iterable<Stone>, Sizeable
+ + +

+Class managing Stones joined together to form sets +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classStoneSet.Type + +
+          Validity type of the set
+  + + + + + + + + + + + + + + +
+Field Summary
+(package private) static floatHORIZONTAL_BORDER + +
+           
+(package private) static floatVERTICAL_BORDER + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
StoneSet(java.util.List<Stone> stones) + +
+          Create a stone set from a list of stones
StoneSet(Stone stone) + +
+          Create a new single stone stone set
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSet.Typeclassify() + +
+          Test for rule conflict within the StoneSet and determine whether the set + is a group or a run
+ Stoneget(int i) + +
+          Returns the i-th stone of the set (starting with 0)
+ floatgetHeight() + +
+          Get the height of the object
+ floatgetWidth() + +
+          Get the width of the object
+ booleanisValid() + +
+          Test for rule conflict within the StoneSet
+ java.util.Iterator<Stone>iterator() + +
+           
+ StoneSetjoin(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+ intsize() + +
+          Returns the number of stones in the set.
+ Pair<StoneSet,StoneSet>splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

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

+VERTICAL_BORDER

+
+static final float VERTICAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+HORIZONTAL_BORDER

+
+static final float HORIZONTAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneSet

+
+public StoneSet(Stone stone)
+
+
Create a new single stone stone set +

+

+
Parameters:
stone - single stone of the set
+
+
+ +

+StoneSet

+
+public StoneSet(java.util.List<Stone> stones)
+
+
Create a stone set from a list of stones +

+

+
Parameters:
stones - list of stones to build a set of
+
+ + + + + + + + +
+Method Detail
+ +

+isValid

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

+

+
+
+
+ +
Returns:
true when the set is valid according to the rules
+
+
+
+ +

+classify

+
+public StoneSet.Type classify()
+
+
Test for rule conflict within the StoneSet and determine whether the set + is a group or a run +

+

+
+
+
+ +
Returns:
GROUP or RUN for valid sets, INVALID otherwise
+
+
+
+ +

+splitAt

+
+public Pair<StoneSet,StoneSet> splitAt(int position)
+
+
Splits the StoneSet at a specified Position and returns two new + Stone Sets +

+

+
+
+
+
Parameters:
position - Splitting Position +
Returns:
A pair of StoneSets, one for each split part
+
+
+
+ +

+join

+
+public StoneSet join(StoneSet other)
+
+
Joins StoneSet to another StoneSet and returns the resulting new StoneSet +

+

+
+
+
+
Parameters:
other - StoneSet to be joined to active StoneSet +
Returns:
the combined StoneSet
+
+
+
+ +

+size

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

+

+
+
+
+ +
Returns:
number of stones
+
+
+
+ +

+get

+
+public Stone get(int i)
+
+
Returns the i-th stone of the set (starting with 0) +

+

+
+
+
+
Parameters:
i - number of the stone to return +
Returns:
the i-th stone
+
+
+
+ +

+iterator

+
+public java.util.Iterator<Stone> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<Stone>
+
+
+
+
+
+
+ +

+getWidth

+
+public float getWidth()
+
+
Description copied from interface: Sizeable
+
Get the width of the object +

+

+
Specified by:
getWidth in interface Sizeable
+
+
+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+public float getHeight()
+
+
Description copied from interface: Sizeable
+
Get the height of the object +

+

+
Specified by:
getHeight in interface Sizeable
+
+
+ +
Returns:
object height
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + -- cgit v1.2.3