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>
|
||||
StoneSet
|
||||
</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">
|
||||
|
||||
|
|
@ -96,11 +96,11 @@ java.lang.Object
|
|||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.StoneSet</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></DD>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>StoneSet</B><DT>extends java.lang.Object<DT>implements java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></DL>
|
||||
<DT><PRE>public class <B>StoneSet</B><DT>extends java.lang.Object<DT>implements java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A>, java.io.Serializable</DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
|
|
@ -108,6 +108,8 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#jrummikub.model.StoneSet">Serialized Form</A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
|
@ -141,6 +143,22 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
<CODE>(package private) static float</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#HORIZONTAL_BORDER">HORIZONTAL_BORDER</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/StoneSet.html#serialVersionUID">serialVersionUID</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>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/StoneSet.html#stones">stones</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
|
|
@ -186,12 +204,21 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#classify()">classify</A></B>()</CODE>
|
||||
<CODE> <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#classify(jrummikub.model.GameSettings)">classify</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
Test for rule conflict within the StoneSet and determine whether the set
|
||||
is a group or a run</TD>
|
||||
Test for rule conflict within the StoneSet and determine whether the set is
|
||||
a group or a run</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#classifyJokersOnly(jrummikub.model.GameSettings)">classifyJokersOnly</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
Test for rule conflict within a StoneSet with jokers only and determine
|
||||
whether the set is a group or a run</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
|
|
@ -211,6 +238,14 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#getSize()">getSize</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the number of stones in the set.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> float</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#getWidth()">getWidth</A></B>()</CODE>
|
||||
|
||||
|
|
@ -220,13 +255,31 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValid()">isValid</A></B>()</CODE>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValid(jrummikub.model.GameSettings)">isValid</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
Test for rule conflict within the StoneSet</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValidGroup(int, jrummikub.model.GameSettings)">isValidGroup</A></B>(int value,
|
||||
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
Test for rule conflict within the StoneSet, assuming we have a group</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValidRun(int, jrummikub.model.GameSettings)">isValidRun</A></B>(int referencePosition,
|
||||
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
Test for rule conflict within the StoneSet, assuming we have a run</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.util.Iterator<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#iterator()">iterator</A></B>()</CODE>
|
||||
|
||||
|
|
@ -243,14 +296,6 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#size()">size</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the number of stones in the set.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>,<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#splitAt(int)">splitAt</A></B>(int position)</CODE>
|
||||
|
||||
|
|
@ -289,6 +334,16 @@ Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummi
|
|||
</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.StoneSet.serialVersionUID">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="VERTICAL_BORDER"><!-- --></A><H3>
|
||||
VERTICAL_BORDER</H3>
|
||||
<PRE>
|
||||
|
|
@ -307,6 +362,16 @@ static final float <B>HORIZONTAL_BORDER</B></PRE>
|
|||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#jrummikub.model.StoneSet.HORIZONTAL_BORDER">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="stones"><!-- --></A><H3>
|
||||
stones</H3>
|
||||
<PRE>
|
||||
private java.util.ArrayList<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> <B>stones</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
|
|
@ -351,10 +416,10 @@ public <B>StoneSet</B>(java.util.List<<A HREF="../../jrummikub/model/Stone.ht
|
|||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="isValid()"><!-- --></A><H3>
|
||||
<A NAME="isValid(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
isValid</H3>
|
||||
<PRE>
|
||||
public boolean <B>isValid</B>()</PRE>
|
||||
public boolean <B>isValid</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Test for rule conflict within the StoneSet
|
||||
<P>
|
||||
|
|
@ -362,26 +427,80 @@ public boolean <B>isValid</B>()</PRE>
|
|||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - GameSettings
|
||||
<DT><B>Returns:</B><DD>true when the set is valid according to the rules</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="classify()"><!-- --></A><H3>
|
||||
<A NAME="classify(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
classify</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A> <B>classify</B>()</PRE>
|
||||
public <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer> <B>classify</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Test for rule conflict within the StoneSet and determine whether the set
|
||||
is a group or a run
|
||||
<DD>Test for rule conflict within the StoneSet and determine whether the set is
|
||||
a group or a run
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - GameSettings
|
||||
<DT><B>Returns:</B><DD>GROUP or RUN for valid sets, INVALID otherwise and the points</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<DT><B>Returns:</B><DD>GROUP or RUN for valid sets, INVALID otherwise</DL>
|
||||
<A NAME="classifyJokersOnly(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
classifyJokersOnly</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer> <B>classifyJokersOnly</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Test for rule conflict within a StoneSet with jokers only and determine
|
||||
whether the set is a group or a run
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the game settings
|
||||
<DT><B>Returns:</B><DD>GROUP or RUN for valid sets, INVALID otherwise and the points</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="isValidRun(int, jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
isValidRun</H3>
|
||||
<PRE>
|
||||
private int <B>isValidRun</B>(int referencePosition,
|
||||
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Test for rule conflict within the StoneSet, assuming we have a run
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>referencePosition</CODE> - position of stone used as reference (any non-joker stone)<DD><CODE>settings</CODE> - the game settings
|
||||
<DT><B>Returns:</B><DD>the set's points</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="isValidGroup(int, jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
isValidGroup</H3>
|
||||
<PRE>
|
||||
private int <B>isValidGroup</B>(int value,
|
||||
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Test for rule conflict within the StoneSet, assuming we have a group
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of the stones (all have the same in a group)<DD><CODE>settings</CODE> - the game settings
|
||||
<DT><B>Returns:</B><DD>the set's points</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
|
@ -421,10 +540,10 @@ public <A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.m
|
|||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="size()"><!-- --></A><H3>
|
||||
size</H3>
|
||||
<A NAME="getSize()"><!-- --></A><H3>
|
||||
getSize</H3>
|
||||
<PRE>
|
||||
public int <B>size</B>()</PRE>
|
||||
public int <B>getSize</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the number of stones in the set.
|
||||
<P>
|
||||
|
|
|
|||
Reference in a new issue