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/IStoneTray.html | 337 ++++++++++++++++++++++++++++++++++++ 1 file changed, 337 insertions(+) create mode 100644 doc/jrummikub/model/IStoneTray.html (limited to 'doc/jrummikub/model/IStoneTray.html') diff --git a/doc/jrummikub/model/IStoneTray.html b/doc/jrummikub/model/IStoneTray.html new file mode 100644 index 0000000..89b891b --- /dev/null +++ b/doc/jrummikub/model/IStoneTray.html @@ -0,0 +1,337 @@ + + + + + + +IStoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 +
+Interface IStoneTray<E extends Sizeable>

+
+
Type Parameters:
E - Objects held by the IStoneTray
+
+
All Superinterfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>
+
+
+
All Known Subinterfaces:
IHand, ITable
+
+
+
All Known Implementing Classes:
Hand, StoneTray, Table
+
+
+
+
public interface IStoneTray<E extends Sizeable>
extends java.lang.Iterable<Pair<E,Position>>, java.lang.Cloneable
+ + +

+Interface for the StoneTray model +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IStoneTray<E>clone() + +
+          Create a clone of the StoneTray
+ voiddrop(E object, + Position position) + +
+          Adds object to the tray
+ PositiongetPosition(E object) + +
+          Returns the position of an object that is already on the tray
+ intgetSize() + +
+          Return the number of objects on the tray
+ booleanpickUp(E object) + +
+          Tries to pick up (remove) a given object
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Method Detail
+ +

+drop

+
+void drop(E object,
+          Position position)
+
+
Adds object to the tray +

+

+
+
+
+
Parameters:
object - object to add to Hand
position - Position to put the object
+
+
+
+ +

+getPosition

+
+Position getPosition(E object)
+
+
Returns the position of an object that is already on the tray +

+

+
+
+
+
Parameters:
object - object whose position is requested +
Returns:
position of the object or null when the object is not on the tray
+
+
+
+ +

+pickUp

+
+boolean pickUp(E object)
+
+
Tries to pick up (remove) a given object +

+

+
+
+
+
Parameters:
object - object to pick up +
Returns:
true when the object was successfully removed
+
+
+
+ +

+clone

+
+IStoneTray<E> clone()
+
+
Create a clone of the StoneTray +

+

+
+
+
+ +
Returns:
cloned StoneTray
+
+
+
+ +

+getSize

+
+int getSize()
+
+
Return the number of objects on the tray +

+

+
+
+
+ +
Returns:
number of objects
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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