diff options
Diffstat (limited to 'doc/jrummikub/model/IHand.html')
| -rw-r--r-- | doc/jrummikub/model/IHand.html | 156 |
1 files changed, 146 insertions, 10 deletions
diff --git a/doc/jrummikub/model/IHand.html b/doc/jrummikub/model/IHand.html index 293f9ad..3c8ea74 100644 --- a/doc/jrummikub/model/IHand.html +++ b/doc/jrummikub/model/IHand.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_22) on Tue May 10 17:04:57 CEST 2011 --> +<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 --> <TITLE> IHand </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"> @@ -55,7 +55,7 @@ function windowTitle() <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>PREV CLASS</B></A> <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../index.html?jrummikub/model/IHand.html" target="_top"><B>FRAMES</B></A> @@ -76,9 +76,9 @@ function windowTitle() </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | METHOD</FONT></TD> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | METHOD</FONT></TD> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> @@ -92,7 +92,7 @@ jrummikub.model</FONT> <BR> Interface IHand</H2> <DL> -<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>></DD> +<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>>, java.io.Serializable</DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model">Hand</A></DD> @@ -119,6 +119,47 @@ Interface for the <A HREF="../../jrummikub/model/Hand.html" title="class in jrum <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </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/IHand.html#getFreeRowSpace(int)">getFreeRowSpace</A></B>(int row)</CODE> + +<BR> + Gets the amount of free space in a hand row</TD> +</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/IHand.html#getIdenticalStoneCount()">getIdenticalStoneCount</A></B>()</CODE> + +<BR> + Counts the pairs of identical stones</TD> +</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/IHand.html#getRowCount()">getRowCount</A></B>()</CODE> + +<BR> + The number of used rows</TD> +</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/IHand.html#getStonePoints(jrummikub.model.GameSettings)">getStonePoints</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE> + +<BR> + Get the accumulated number of points of stones in the hand</TD> +</TR> +<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/IHand.html#isInitialMeldPossible(jrummikub.model.GameSettings)">isInitialMeldPossible</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE> + +<BR> + Tests whether it is possible to lay down an initial meld using the stones + on the hand</TD> +</TR> </TABLE> <A NAME="methods_inherited_from_class_jrummikub.model.IStoneTray"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> @@ -126,7 +167,7 @@ Interface for the <A HREF="../../jrummikub/model/Hand.html" title="class in jrum <TH ALIGN="left"><B>Methods inherited from interface jrummikub.model.<A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../jrummikub/model/IStoneTray.html#clone()">clone</A>, <A HREF="../../jrummikub/model/IStoneTray.html#drop(E, jrummikub.model.Position)">drop</A>, <A HREF="../../jrummikub/model/IStoneTray.html#getPosition(E)">getPosition</A>, <A HREF="../../jrummikub/model/IStoneTray.html#getSize()">getSize</A>, <A HREF="../../jrummikub/model/IStoneTray.html#pickUp(E)">pickUp</A></CODE></TD> +<TD><CODE><A HREF="../../jrummikub/model/IStoneTray.html#clone()">clone</A>, <A HREF="../../jrummikub/model/IStoneTray.html#contains(E)">contains</A>, <A HREF="../../jrummikub/model/IStoneTray.html#drop(E, jrummikub.model.Position)">drop</A>, <A HREF="../../jrummikub/model/IStoneTray.html#getPosition(E)">getPosition</A>, <A HREF="../../jrummikub/model/IStoneTray.html#getSize()">getSize</A>, <A HREF="../../jrummikub/model/IStoneTray.html#pickUp(E)">pickUp</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Iterable"><!-- --></A> @@ -140,6 +181,101 @@ Interface for the <A HREF="../../jrummikub/model/Hand.html" title="class in jrum </TABLE> <P> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getRowCount()"><!-- --></A><H3> +getRowCount</H3> +<PRE> +int <B>getRowCount</B>()</PRE> +<DL> +<DD>The number of used rows +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>the number of rows</DL> +</DD> +</DL> +<HR> + +<A NAME="getFreeRowSpace(int)"><!-- --></A><H3> +getFreeRowSpace</H3> +<PRE> +int <B>getFreeRowSpace</B>(int row)</PRE> +<DL> +<DD>Gets the amount of free space in a hand row +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>row</CODE> - the row number +<DT><B>Returns:</B><DD>the number of stones that can fit into the row</DL> +</DD> +</DL> +<HR> + +<A NAME="getStonePoints(jrummikub.model.GameSettings)"><!-- --></A><H3> +getStonePoints</H3> +<PRE> +int <B>getStonePoints</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE> +<DL> +<DD>Get the accumulated number of points of stones in the hand +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the game settings +<DT><B>Returns:</B><DD>points</DL> +</DD> +</DL> +<HR> + +<A NAME="isInitialMeldPossible(jrummikub.model.GameSettings)"><!-- --></A><H3> +isInitialMeldPossible</H3> +<PRE> +boolean <B>isInitialMeldPossible</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE> +<DL> +<DD>Tests whether it is possible to lay down an initial meld using the stones + on the hand +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the game settings +<DT><B>Returns:</B><DD>true if an initial meld is possible</DL> +</DD> +</DL> +<HR> + +<A NAME="getIdenticalStoneCount()"><!-- --></A><H3> +getIdenticalStoneCount</H3> +<PRE> +int <B>getIdenticalStoneCount</B>()</PRE> +<DL> +<DD>Counts the pairs of identical stones +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>number of identical stone pairs</DL> +</DD> +</DL> <!-- ========= END OF CLASS DATA ========= --> <HR> @@ -171,7 +307,7 @@ Interface for the <A HREF="../../jrummikub/model/Hand.html" title="class in jrum <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>PREV CLASS</B></A> <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../index.html?jrummikub/model/IHand.html" target="_top"><B>FRAMES</B></A> @@ -192,9 +328,9 @@ Interface for the <A HREF="../../jrummikub/model/Hand.html" title="class in jrum </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | METHOD</FONT></TD> + SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | METHOD</FONT></TD> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> |