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/StoneTray.html | 258 ++++++++++++++++++++++++++++++++++++- 1 file changed, 255 insertions(+), 3 deletions(-) (limited to 'doc/jrummikub/model/StoneTray.html') diff --git a/doc/jrummikub/model/StoneTray.html b/doc/jrummikub/model/StoneTray.html index 60468cb..f5e457c 100644 --- a/doc/jrummikub/model/StoneTray.html +++ b/doc/jrummikub/model/StoneTray.html @@ -2,12 +2,12 @@ - + StoneTray - + @@ -98,7 +98,7 @@ java.lang.Object
Type Parameters:
E - Type of positioned objects (must implement Sizeable)
-
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>, IStoneTray<E>
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>, IStoneTray<E>
Direct Known Subclasses:
Hand, Table
@@ -114,6 +114,8 @@ A StoneTray is a collection of positioned objects (for example Serialized Form

@@ -147,6 +149,14 @@ A StoneTray is a collection of positioned objects (for example E,Pair<E,Position>> objects +
+            + + + +private static long +serialVersionUID +
            @@ -186,6 +196,14 @@ A StoneTray is a collection of positioned objects (for example + boolean +contains(E object) + +
+          Search for an object within the stone tray + + +  void drop(E object, Position position) @@ -195,6 +213,27 @@ A StoneTray is a collection of positioned objects (for example +private  void +drop(E object, + Position position, + StoneTray.Direction direction) + +
+          Subroutine to "drop" to consider and determine the direction the objects + dropped one collides with position-wise evade in + + + +private  void +dropUnchecked(E object, + Position position, + StoneTray.Direction direction) + +
+          Subroutine to "drop" to execute the actual drop + + + protected  Pair<Position,StoneTray.Direction> fixInvalidDrop(E object, Position pos, @@ -206,6 +245,38 @@ A StoneTray is a collection of positioned objects (for example +private  StoneTray.Direction +getMoveDirection(E object, + Position position, + Pair<E,Position> blocking) + +
+          Returns the direction to move the object in + + + +private  boolean +getMoveOrientation(E object, + Position position, + Pair<E,Position> blocking) + +
+          Will the object be moved horizontally or vertically + + + +private  Position +getNewPosition(E object, + Position position, + StoneTray.Direction newDirection, + E currentObject, + Position currentPosition) + +
+            + + +  Position getPosition(E object) @@ -230,6 +301,27 @@ A StoneTray is a collection of positioned objects (for example +private static boolean +lessOrEqual(double d, + double e) + +
+          Static method for determining a less or equal relation considering a + small fuzziness + + + +private  boolean +objectsOverlap(E object1, + Position position1, + E object2, + Position position2) + +
+          Tests whether two objects overlap + + +  boolean pickUp(E object) @@ -259,6 +351,16 @@ A StoneTray is a collection of positioned objects (for example

+serialVersionUID

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

objects

@@ -313,6 +415,61 @@ public void drop(

+drop

+
+private void drop(E object,
+                  Position position,
+                  StoneTray.Direction direction)

+

+
Subroutine to "drop" to consider and determine the direction the objects
+ dropped one collides with position-wise evade in
+

+

+

+

+

+
Parameters:
object - the object to add to Hand
position - Position to put the object
direction - the direction the other stones evade in

+

+

+

+
+

+dropUnchecked

+
+private void dropUnchecked(E object,
+                           Position position,
+                           StoneTray.Direction direction)

+

+
Subroutine to "drop" to execute the actual drop
+

+

+

+

+

+
Parameters:
object - the object to add to Hand
position - Position to put the object
direction - the direction the other stones evade in

+

+

+

+
+

+getNewPosition

+
+private Position getNewPosition(E object,
+                                Position position,
+                                StoneTray.Direction newDirection,
+                                E currentObject,
+                                Position currentPosition)

+

+

+

+

+

+

+

+

+

+
 

 fixInvalidDrop

 
@@ -333,6 +490,83 @@ protected 

+lessOrEqual

+
+private static boolean lessOrEqual(double d,
+                                   double e)

+

+
Static method for determining a less or equal relation considering a
+ small fuzziness
+

+

+

+

+

+
Parameters:
d - the value to be less or equal
e - than the other one
+
Returns:
if d is less or equal e

+

+

+

+
+

+objectsOverlap

+
+private boolean objectsOverlap(E object1,
+                               Position position1,
+                               E object2,
+                               Position position2)

+

+
Tests whether two objects overlap
+

+

+

+

+

+
Parameters:
object1 - first object
position1 - first object's position
object2 - second object
position2 - second object's position
+
Returns:
whether they overlap

+

+

+

+
+

+getMoveDirection

+
+private StoneTray.Direction getMoveDirection(E object,
+                                             Position position,
+                                             Pair<E,Position> blocking)

+

+
Returns the direction to move the object in
+

+

+

+

+

+
Parameters:
object - the object
position - the object's position
blocking - the object thats blocking
+
Returns:
the direction

+

+

+

+
+

+getMoveOrientation

+
+private boolean getMoveOrientation(E object,
+                                   Position position,
+                                   Pair<E,Position> blocking)

+

+
Will the object be moved horizontally or vertically
+

+

+

+

+

+
Parameters:
object - the object
position - the objects position
blocking - the object thats blocking
+
Returns:
boolean vertical movement

+

+

+

+
 

 getPosition

 
@@ -351,6 +585,24 @@ public 

+contains

+
+public boolean contains(E object)

+

+
Description copied from interface: IStoneTray

+
Search for an object within the stone tray
+

+

+
Specified by:
contains in interface IStoneTray<E extends Sizeable>

+

+

+
Parameters:
object - object to search for
+
Returns:
object found in stone tray

+

+

+

+
 

 iterator

 
-- 
cgit v1.2.3