<!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 May 10 17:04:57 CEST 2011 -->
<TITLE>
GameState
</TITLE>
<META NAME="date" CONTENT="2011-05-10">
<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="GameState";
}
}
</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/GameState.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">
PREV CLASS
<A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?jrummikub/model/GameState.html" target="_top"><B>FRAMES</B></A>
<A HREF="GameState.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">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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 GameState</H2>
<PRE>
java.lang.Object
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.GameState</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>GameState</B><DT>extends java.lang.Object<DT>implements <A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></DL>
</PRE>
<P>
Class managing the overall and momentary GameState
<P>
<P>
<HR>
<P>
<!-- ======== 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/GameState.html#GameState()">GameState</A></B>()</CODE>
<BR>
Create a new GameState with an empty table and (currently) 4 new players.</TD>
</TR>
</TABLE>
<!-- ========== 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> <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model">IPlayer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#getActivePlayer()">getActivePlayer</A></B>()</CODE>
<BR>
Returns the currently active player</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../jrummikub/model/StoneHeap.html" title="class in jrummikub.model">StoneHeap</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#getGameHeap()">getGameHeap</A></B>()</CODE>
<BR>
Returns the heap of stones to draw from</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model">IPlayer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#getNthNextPlayer(int)">getNthNextPlayer</A></B>(int i)</CODE>
<BR>
Returns the player that would be the active player after i turns</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/GameState.html#getPlayerCount()">getPlayerCount</A></B>()</CODE>
<BR>
Returns the number of players</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#getTable()">getTable</A></B>()</CODE>
<BR>
Get the current <A HREF="../../jrummikub/model/Table.html" title="class in jrummikub.model"><CODE>Table</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#nextPlayer()">nextPlayer</A></B>()</CODE>
<BR>
Changes the activePlayer to the next <A HREF="../../jrummikub/model/Player.html" title="class in jrummikub.model"><CODE>Player</CODE></A> in the list</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../jrummikub/model/GameState.html#setTable(jrummikub.model.ITable)">setTable</A></B>(<A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table)</CODE>
<BR>
Sets the current <A HREF="../../jrummikub/model/Table.html" title="class in jrummikub.model"><CODE>Table</CODE></A></TD>
</TR>
</TABLE>
<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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= 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="GameState()"><!-- --></A><H3>
GameState</H3>
<PRE>
public <B>GameState</B>()</PRE>
<DL>
<DD>Create a new GameState with an empty table and (currently) 4 new players.
<P>
</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="getTable()"><!-- --></A><H3>
getTable</H3>
<PRE>
public <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> <B>getTable</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#getTable()">IGameState</A></CODE></B></DD>
<DD>Get the current <A HREF="../../jrummikub/model/Table.html" title="class in jrummikub.model"><CODE>Table</CODE></A>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#getTable()">getTable</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The current Table</DL>
</DD>
</DL>
<HR>
<A NAME="setTable(jrummikub.model.ITable)"><!-- --></A><H3>
setTable</H3>
<PRE>
public void <B>setTable</B>(<A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A> table)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#setTable(jrummikub.model.ITable)">IGameState</A></CODE></B></DD>
<DD>Sets the current <A HREF="../../jrummikub/model/Table.html" title="class in jrummikub.model"><CODE>Table</CODE></A>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#setTable(jrummikub.model.ITable)">setTable</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>table</CODE> - The new Table</DL>
</DD>
</DL>
<HR>
<A NAME="getPlayerCount()"><!-- --></A><H3>
getPlayerCount</H3>
<PRE>
public int <B>getPlayerCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#getPlayerCount()">IGameState</A></CODE></B></DD>
<DD>Returns the number of players
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#getPlayerCount()">getPlayerCount</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>number of players</DL>
</DD>
</DL>
<HR>
<A NAME="nextPlayer()"><!-- --></A><H3>
nextPlayer</H3>
<PRE>
public void <B>nextPlayer</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#nextPlayer()">IGameState</A></CODE></B></DD>
<DD>Changes the activePlayer to the next <A HREF="../../jrummikub/model/Player.html" title="class in jrummikub.model"><CODE>Player</CODE></A> in the list
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#nextPlayer()">nextPlayer</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNthNextPlayer(int)"><!-- --></A><H3>
getNthNextPlayer</H3>
<PRE>
public <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model">IPlayer</A> <B>getNthNextPlayer</B>(int i)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#getNthNextPlayer(int)">IGameState</A></CODE></B></DD>
<DD>Returns the player that would be the active player after i turns
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#getNthNextPlayer(int)">getNthNextPlayer</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - number of turns
<DT><B>Returns:</B><DD>player active after i turns</DL>
</DD>
</DL>
<HR>
<A NAME="getActivePlayer()"><!-- --></A><H3>
getActivePlayer</H3>
<PRE>
public <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model">IPlayer</A> <B>getActivePlayer</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#getActivePlayer()">IGameState</A></CODE></B></DD>
<DD>Returns the currently active player
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#getActivePlayer()">getActivePlayer</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>currently active player</DL>
</DD>
</DL>
<HR>
<A NAME="getGameHeap()"><!-- --></A><H3>
getGameHeap</H3>
<PRE>
public <A HREF="../../jrummikub/model/StoneHeap.html" title="class in jrummikub.model">StoneHeap</A> <B>getGameHeap</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/IGameState.html#getGameHeap()">IGameState</A></CODE></B></DD>
<DD>Returns the heap of stones to draw from
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/IGameState.html#getGameHeap()">getGameHeap</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/IGameState.html" title="interface in jrummikub.model">IGameState</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>heap of stones</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> </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/GameState.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">
PREV CLASS
<A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?jrummikub/model/GameState.html" target="_top"><B>FRAMES</B></A>
<A HREF="GameState.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">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>