neocturne/JRummikub
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Javadoc

Browse source 
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
This commit is contained in:
Ida Massow 2011-07-06 16:36:06 +02:00
parent 3193477354
commit 51b7fbe822
156 changed files with 22852 additions and 2001 deletions
Download patch file Download diff file Expand all files Collapse all files

156
doc/jrummikub/model/IHand.html
View file

@ -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">
&nbsp;<A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<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> &nbsp;
@ -76,9 +76,9 @@ function windowTitle()
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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>&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;, java.lang.Iterable&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;<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>&gt;&gt;</DD>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A>&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;, java.lang.Iterable&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;<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>&gt;&gt;, 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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/IHand.html#getFreeRowSpace(int)">getFreeRowSpace</A></B>(int&nbsp;row)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/IHand.html#getIdenticalStoneCount()">getIdenticalStoneCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Counts the pairs of identical stones</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/IHand.html#getRowCount()">getRowCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of used rows</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;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>&nbsp;settings)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;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>&nbsp;settings)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether it is possible to lay down an initial meld using the stones
on the hand</TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;<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>
&nbsp;
<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&nbsp;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>&nbsp;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>&nbsp;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">
&nbsp;<A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<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> &nbsp;
@ -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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>