Javadoc
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Ida Massow
parent
3193477354
commit
51b7fbe822
156 changed files with 22852 additions and 2001 deletions
|
|
@ -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,9 +124,25 @@ 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) java.util.List<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></FONT></TD>
|
||||
<CODE>private java.util.Random</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#generator">generator</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>(package private) java.util.ArrayList<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#heap">heap</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private static long</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneHeap.html#serialVersionUID">serialVersionUID</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
|
|
@ -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> gameSettings)</CODE>
|
||||
|
||||
<BR>
|
||||
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<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> <B>heap</B></PRE>
|
||||
java.util.ArrayList<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> <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<<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> 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<<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<<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>
|
||||
|
|
|
|||
Reference in a new issue