neocturne/JRummikub
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
This repository has been archived on 2025-03-02. You can view files and clone it, but cannot push or open issues or pull requests.
JRummikub/doc/jrummikub/model/Hand.html
Ida Massow 51b7fbe822 Javadoc 
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
2011-07-06 16:36:06 +02:00

589 lines
29 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 -->
<TITLE>
Hand
</TITLE>
<META NAME="date" CONTENT="2011-07-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Hand";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Hand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../jrummikub/model/GameState.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../jrummikub/model/IHand.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/Hand.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Hand.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_jrummikub.model.StoneTray">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
jrummikub.model</FONT>
<BR>
Class Hand</H2>
<PRE>
java.lang.Object
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">jrummikub.model.StoneTray</A>&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.Hand</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, 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;, <A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A>, <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;</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>Hand</B><DT>extends <A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A>&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;<DT>implements <A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></DL>
</PRE>
<P>
Class managing a <A HREF="../../jrummikub/model/Player.html" title="class in jrummikub.model"><CODE>Player</CODE></A>'s <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model"><CODE>Stone</CODE></A>s
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#jrummikub.model.Hand">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="nested_classes_inherited_from_class_jrummikub.model.StoneTray"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from class jrummikub.model.<A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model">StoneTray.Direction</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.util.Comparator&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#comparator">comparator</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The measure to compare the stones by</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/Hand.html#serialVersionUID">serialVersionUID</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>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#WIDTH">WIDTH</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The width of the hand</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_jrummikub.model.StoneTray"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class jrummikub.model.<A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../jrummikub/model/StoneTray.html#objects">objects</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#Hand()">Hand</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<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>private static&nbsp;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.util.TreeMap&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;,java.lang.Integer&gt;,java.lang.Integer&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#countStones(java.util.List)">countStones</A></B>(java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;&nbsp;stones)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Counts the numbers of stones</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>,<A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model">StoneTray.Direction</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#fixInvalidDrop(jrummikub.model.Stone, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)">fixInvalidDrop</A></B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&nbsp;stone,
<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>&nbsp;pos,
<A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model">StoneTray.Direction</A>&nbsp;dir)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether the object may be placed on the given position, computes
new position if not</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/Hand.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/Hand.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/Hand.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/Hand.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>private static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/Hand.html#incrementStoneCount(java.util.TreeMap, jrummikub.util.Pair)">incrementStoneCount</A></B>(java.util.TreeMap&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;,java.lang.Integer&gt;&nbsp;stones,
<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;&nbsp;stone)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the count of a stone in the list of all stones</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/Hand.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.StoneTray"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class jrummikub.model.<A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../jrummikub/model/StoneTray.html#clone()">clone</A>, <A HREF="../../jrummikub/model/StoneTray.html#contains(E)">contains</A>, <A HREF="../../jrummikub/model/StoneTray.html#drop(E, jrummikub.model.Position)">drop</A>, <A HREF="../../jrummikub/model/StoneTray.html#getPosition(E)">getPosition</A>, <A HREF="../../jrummikub/model/StoneTray.html#getSize()">getSize</A>, <A HREF="../../jrummikub/model/StoneTray.html#iterator()">iterator</A>, <A HREF="../../jrummikub/model/StoneTray.html#pickUp(E)">pickUp</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_jrummikub.model.IStoneTray"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<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#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>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface java.lang.Iterable</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>iterator</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</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.Hand.serialVersionUID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="WIDTH"><!-- --></A><H3>
WIDTH</H3>
<PRE>
public static final int <B>WIDTH</B></PRE>
<DL>
<DD>The width of the hand
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#jrummikub.model.Hand.WIDTH">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="comparator"><!-- --></A><H3>
comparator</H3>
<PRE>
private static final java.util.Comparator&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;&gt; <B>comparator</B></PRE>
<DL>
<DD>The measure to compare the stones by
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Hand()"><!-- --></A><H3>
Hand</H3>
<PRE>
public <B>Hand</B>()</PRE>
<DL>
</DL>
<!-- ============ 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="getFreeRowSpace(int)"><!-- --></A><H3>
getFreeRowSpace</H3>
<PRE>
public int <B>getFreeRowSpace</B>(int&nbsp;row)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IHand.html#getFreeRowSpace(int)">IHand</A></CODE></B></DD>
<DD>Gets the amount of free space in a hand row
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IHand.html#getFreeRowSpace(int)">getFreeRowSpace</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></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="getRowCount()"><!-- --></A><H3>
getRowCount</H3>
<PRE>
public int <B>getRowCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IHand.html#getRowCount()">IHand</A></CODE></B></DD>
<DD>The number of used rows
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IHand.html#getRowCount()">getRowCount</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of rows</DL>
</DD>
</DL>
<HR>
<A NAME="fixInvalidDrop(jrummikub.model.Stone, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)"><!-- --></A><H3>
fixInvalidDrop</H3>
<PRE>
protected <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>,<A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model">StoneTray.Direction</A>&gt; <B>fixInvalidDrop</B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&nbsp;stone,
<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>&nbsp;pos,
<A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model">StoneTray.Direction</A>&nbsp;dir)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../jrummikub/model/StoneTray.html#fixInvalidDrop(E, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)">StoneTray</A></CODE></B></DD>
<DD>Checks whether the object may be placed on the given position, computes
new position if not
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../jrummikub/model/StoneTray.html#fixInvalidDrop(E, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)">fixInvalidDrop</A></CODE> in class <CODE><A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A>&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stone</CODE> - to be dropped<DD><CODE>pos</CODE> - the object is dropped at
<DT><B>Returns:</B><DD>null if the drop is valid, new position otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="getStonePoints(jrummikub.model.GameSettings)"><!-- --></A><H3>
getStonePoints</H3>
<PRE>
public int <B>getStonePoints</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A>&nbsp;settings)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IHand.html#getStonePoints(jrummikub.model.GameSettings)">IHand</A></CODE></B></DD>
<DD>Get the accumulated number of points of stones in the hand
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IHand.html#getStonePoints(jrummikub.model.GameSettings)">getStonePoints</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></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>
public boolean <B>isInitialMeldPossible</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A>&nbsp;settings)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IHand.html#isInitialMeldPossible(jrummikub.model.GameSettings)">IHand</A></CODE></B></DD>
<DD>Tests whether it is possible to lay down an initial meld using the stones
on the hand
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IHand.html#isInitialMeldPossible(jrummikub.model.GameSettings)">isInitialMeldPossible</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></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="incrementStoneCount(java.util.TreeMap, jrummikub.util.Pair)"><!-- --></A><H3>
incrementStoneCount</H3>
<PRE>
private static void <B>incrementStoneCount</B>(java.util.TreeMap&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;,java.lang.Integer&gt;&nbsp;stones,
<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;&nbsp;stone)</PRE>
<DL>
<DD>Increments the count of a stone in the list of all stones
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stones</CODE> - all stones and their respective numbers<DD><CODE>stone</CODE> - the start stone</DL>
</DD>
</DL>
<HR>
<A NAME="countStones(java.util.List)"><!-- --></A><H3>
countStones</H3>
<PRE>
private static <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.util.TreeMap&lt;<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A>&lt;java.lang.Integer,<A HREF="../../jrummikub/model/StoneColor.html" title="enum in jrummikub.model">StoneColor</A>&gt;,java.lang.Integer&gt;,java.lang.Integer&gt; <B>countStones</B>(java.util.List&lt;<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>&gt;&nbsp;stones)</PRE>
<DL>
<DD>Counts the numbers of stones
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stones</CODE> - the stones to count
<DT><B>Returns:</B><DD>the numbers for all stones</DL>
</DD>
</DL>
<HR>
<A NAME="getIdenticalStoneCount()"><!-- --></A><H3>
getIdenticalStoneCount</H3>
<PRE>
public int <B>getIdenticalStoneCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IHand.html#getIdenticalStoneCount()">IHand</A></CODE></B></DD>
<DD>Counts the pairs of identical stones
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IHand.html#getIdenticalStoneCount()">getIdenticalStoneCount</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>number of identical stone pairs</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Hand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../jrummikub/model/GameState.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../jrummikub/model/IHand.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/Hand.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Hand.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_jrummikub.model.StoneTray">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
Reference in a new issue View git blame Copy permalink