summaryrefslogtreecommitdiffstats
path: root/doc/jrummikub/model/StoneHeap.html
diff options
context:
space:
mode:
authorIda Massow <massow@informatik.uni-luebeck.de>2011-07-06 16:36:06 +0200
committerIda Massow <massow@informatik.uni-luebeck.de>2011-07-06 16:36:06 +0200
commit51b7fbe822bd9a3804c061f0b844884769d7ddba (patch)
tree152d79321131936d1bc49e959d2a7a2628c592cb /doc/jrummikub/model/StoneHeap.html
parent3193477354fc63477a3f42c94023fa84c129adf1 (diff)
downloadJRummikub-master.tar
JRummikub-master.zip
JavadocHEADmaster
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'doc/jrummikub/model/StoneHeap.html')
-rw-r--r--doc/jrummikub/model/StoneHeap.html71
1 files changed, 63 insertions, 8 deletions
diff --git a/doc/jrummikub/model/StoneHeap.html b/doc/jrummikub/model/StoneHeap.html
index 35429a0..e0eb1ee 100644
--- a/doc/jrummikub/model/StoneHeap.html
+++ b/doc/jrummikub/model/StoneHeap.html
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_22) on Tue May 10 17:04:58 CEST 2011 -->
+<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 -->
<TITLE>
StoneHeap
</TITLE>
-<META NAME="date" CONTENT="2011-05-10">
+<META NAME="date" CONTENT="2011-07-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
@@ -95,9 +95,12 @@ Class StoneHeap</H2>
java.lang.Object
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.StoneHeap</B>
</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
<HR>
<DL>
-<DT><PRE>public class <B>StoneHeap</B><DT>extends java.lang.Object</DL>
+<DT><PRE>public class <B>StoneHeap</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
</PRE>
<P>
@@ -106,6 +109,8 @@ StoneHeap creates all <A HREF="../../jrummikub/model/Stone.html" title="class in
<P>
<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#jrummikub.model.StoneHeap">Serialized Form</A></DL>
<HR>
<P>
@@ -119,12 +124,28 @@ StoneHeap creates all <A HREF="../../jrummikub/model/Stone.html" title="class in
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>(package private) &nbsp;java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;</CODE></FONT></TD>
+<CODE>private &nbsp;java.util.Random</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#generator">generator</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>(package private) &nbsp;java.util.ArrayList&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#heap">heap</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private static&nbsp;long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#serialVersionUID">serialVersionUID</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
@@ -136,7 +157,7 @@ StoneHeap creates all <A HREF="../../jrummikub/model/Stone.html" title="class in
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#StoneHeap()">StoneHeap</A></B>()</CODE>
+<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#StoneHeap(jrummikub.model.GameSettings)">StoneHeap</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A>&nbsp;gameSettings)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates 106 Stones according to standard rules</TD>
@@ -206,10 +227,30 @@ StoneHeap creates all <A HREF="../../jrummikub/model/Stone.html" title="class in
</TR>
</TABLE>
+<A NAME="serialVersionUID"><!-- --></A><H3>
+serialVersionUID</H3>
+<PRE>
+private static final long <B>serialVersionUID</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#jrummikub.model.StoneHeap.serialVersionUID">Constant Field Values</A></DL>
+</DL>
+<HR>
+
<A NAME="heap"><!-- --></A><H3>
heap</H3>
<PRE>
-java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt; <B>heap</B></PRE>
+java.util.ArrayList&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt; <B>heap</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="generator"><!-- --></A><H3>
+generator</H3>
+<PRE>
+private java.util.Random <B>generator</B></PRE>
<DL>
<DL>
</DL>
@@ -225,13 +266,15 @@ java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jru
</TR>
</TABLE>
-<A NAME="StoneHeap()"><!-- --></A><H3>
+<A NAME="StoneHeap(jrummikub.model.GameSettings)"><!-- --></A><H3>
StoneHeap</H3>
<PRE>
-public <B>StoneHeap</B>()</PRE>
+public <B>StoneHeap</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A>&nbsp;gameSettings)</PRE>
<DL>
<DD>Creates 106 Stones according to standard rules
<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>gameSettings</CODE> - (for number of sets/jokers, colors etc.)</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -252,6 +295,9 @@ public <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.mode
<DD>Removes random <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model"><CODE>Stone</CODE></A> from the heap and returns it
<P>
<DD><DL>
+</DL>
+</DD>
+<DD><DL>
<DT><B>Returns:</B><DD>the drawn stone</DL>
</DD>
@@ -266,6 +312,9 @@ public java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class
<DD>Removes several <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model"><CODE>Stone</CODE></A>s from the heap and returns them
<P>
<DD><DL>
+</DL>
+</DD>
+<DD><DL>
<DT><B>Parameters:</B><DD><CODE>number</CODE> - number of requested Stones
<DT><B>Returns:</B><DD>list of drawn stones</DL>
</DD>
@@ -280,6 +329,9 @@ public int <B>getSize</B>()</PRE>
<DD>Get the number of stones left
<P>
<DD><DL>
+</DL>
+</DD>
+<DD><DL>
<DT><B>Returns:</B><DD>number of stones on the heap</DL>
</DD>
@@ -294,6 +346,9 @@ public void <B>putBack</B>(java.util.Collection&lt;<A HREF="../../jrummikub/mode
<DD>Put stones back on the heap
<P>
<DD><DL>
+</DL>
+</DD>
+<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stones</CODE> - collection of stones to put back</DL>
</DD>
</DL>