+StoneHeap +

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/StoneHeap.html | 363 +++++++++++++++++++++++++++++++++++++ 1 file changed, 363 insertions(+) create mode 100644 doc/jrummikub/model/StoneHeap.html (limited to 'doc/jrummikub/model/StoneHeap.html') diff --git a/doc/jrummikub/model/StoneHeap.html b/doc/jrummikub/model/StoneHeap.html new file mode 100644 index 0000000..d08f77c --- /dev/null +++ b/doc/jrummikub/model/StoneHeap.html @@ -0,0 +1,363 @@ + + + + + + +StoneHeap + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

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 StoneHeap

+java.lang.Object
+  jrummikub.model.StoneHeap
+

public class StoneHeap
extends java.lang.Object
extends java.lang.Object

+ + +

+StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones. +

+ +

+ + + + + + + + + + + +
+Field Summary
+(package private) java.util.List<Stone> heap + +
+
+ + + + + + + + + + + +
+Constructor Summary
StoneHeap() + +
+          Creates 106 Stones according to standard rules
+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Stone drawStone() + +
+          Removes random Stone from the heap and returns it
+ java.util.List<Stone> drawStones(int number) + +
+          Removes several Stones from the heap and returns them
+ int getSize() + +
+          Get the number of stones left
+ void putBack(java.util.Collection<Stone> stones) + +
+          Put stones back on the heap
+ + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

+Field Summary
+`(package private) java.util.List<Stone>`	`heap` + + +

+Constructor Summary
`StoneHeap()` + + + Creates 106 Stones according to standard rules

+Method Summary
+ `Stone`	`drawStone()` + + + Removes random `Stone` from the heap and returns it
+ `java.util.List<Stone>`	`drawStones(int number)` + + + Removes several `Stone`s from the heap and returns them
+ `int`	`getSize()` + + + Get the number of stones left
+ `void`	`putBack(java.util.Collection<Stone> stones)` + + + Put stones back on the heap

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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

+heap

+java.util.List<Stone> heap

+ + + + + + + + + + +

+Constructor Detail

+ +

+StoneHeap

+public StoneHeap()

Creates 106 Stones according to standard rules +

+ + + + + + + + +

+Method Detail

+ +

+drawStone

+public Stone drawStone()

Removes random Stone from the heap and returns it +

Returns:: the drawn stone

+ +

+drawStones

+public java.util.List<Stone> drawStones(int number)

Removes several Stones from the heap and returns them +

Parameters:: number - number of requested Stones +
Returns:: list of drawn stones

+ +

+getSize

+public int getSize()

Get the number of stones left +

Returns:: number of stones on the heap

+ +

+putBack

+public void putBack(java.util.Collection<Stone> stones)

Put stones back on the heap +

Parameters:: stones - collection of stones to put back

+ +