2011-05-10 16:59:40 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< HTML >
< HEAD >
2011-07-06 16:36:06 +02:00
<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 -->
2011-05-10 16:59:40 +02:00
< TITLE >
IHand
< / TITLE >
2011-07-06 16:36:06 +02:00
< META NAME = "date" CONTENT = "2011-07-05" >
2011-05-10 16:59:40 +02:00
< 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="IHand";
}
}
< / 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 > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/IHand.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../index-files/index-1.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
2011-07-06 16:36:06 +02:00
< A HREF = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > < B > PREV CLASS< / B > < / A >
2011-05-10 16:59:40 +02:00
< 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 >
< A HREF = "IHand.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< 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" >
2011-07-06 16:36:06 +02:00
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
2011-05-10 16:59:40 +02:00
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
2011-07-06 16:36:06 +02:00
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
2011-05-10 16:59:40 +02:00
< / 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 >
Interface IHand< / H2 >
< DL >
2011-07-06 16:36:06 +02:00
< 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 >
2011-05-10 16:59:40 +02:00
< / DL >
< DL >
< DT > < B > All Known Implementing Classes:< / B > < DD > < A HREF = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > Hand< / A > < / DD >
< / DL >
< HR >
< DL >
< DT > < PRE > public interface < B > IHand< / B > < DT > extends < 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 > > < / DL >
< / PRE >
< P >
Interface for the < A HREF = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > < CODE > Hand< / CODE > < / A > model
< P >
< P >
< HR >
< P >
<!-- ========== 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 >
2011-07-06 16:36:06 +02:00
< 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 >
2011-05-10 16:59:40 +02:00
< / TABLE >
< 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" >
2011-07-06 16:36:06 +02:00
< 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 >
2011-05-10 16:59:40 +02:00
< / TR >
< / TABLE >
< 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 >
< P >
2011-07-06 16:36:06 +02:00
<!-- ============ 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 >
2011-05-10 16:59:40 +02:00
<!-- ========= 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 > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/IHand.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../index-files/index-1.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
2011-07-06 16:36:06 +02:00
< A HREF = "../../jrummikub/model/Hand.html" title = "class in jrummikub.model" > < B > PREV CLASS< / B > < / A >
2011-05-10 16:59:40 +02:00
< 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 >
< A HREF = "IHand.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< 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" >
2011-07-06 16:36:06 +02:00
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
2011-05-10 16:59:40 +02:00
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
2011-07-06 16:36:06 +02:00
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
2011-05-10 16:59:40 +02:00
< / TR >
< / TABLE >
< A NAME = "skip-navbar_bottom" > < / A >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< HR >
< / BODY >
< / HTML >
