Javadoc
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
This commit is contained in:
parent
3193477354
commit
51b7fbe822
156 changed files with 22852 additions and 2001 deletions
|
@ -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>
|
||||
IPlayer
|
||||
</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">
|
||||
|
||||
|
@ -56,7 +56,7 @@ function windowTitle()
|
|||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<A HREF="../../jrummikub/model/IRoundState.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/IPlayer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IPlayer.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
@ -92,11 +92,14 @@ jrummikub.model</FONT>
|
|||
<BR>
|
||||
Interface IPlayer</H2>
|
||||
<DL>
|
||||
<DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../jrummikub/model/Player.html" title="class in jrummikub.model">Player</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public interface <B>IPlayer</B></DL>
|
||||
<DT><PRE>public interface <B>IPlayer</B><DT>extends java.io.Serializable</DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
|
@ -118,14 +121,6 @@ Interface for <A HREF="../../jrummikub/model/Player.html" title="class in jrummi
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.awt.Color</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/IPlayer.html#getColor()">getColor</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Return the player's color</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/IPlayer.html#getHand()">getHand</A></B>()</CODE>
|
||||
|
||||
|
@ -134,11 +129,67 @@ Interface for <A HREF="../../jrummikub/model/Player.html" title="class in jrummi
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> java.lang.String</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/IPlayer.html#getName()">getName</A></B>()</CODE>
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/IPlayer.html#getLaidOut()">getLaidOut</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Return the name of the player</TD>
|
||||
Has the player laid out yet?</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/IPlayer.html#getLastTurnStoneCount()">getLastTurnStoneCount</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Gets the number of stones put on table in player's last turn</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../jrummikub/model/PlayerSettings.html" title="class in jrummikub.model">PlayerSettings</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/IPlayer.html#getPlayerSettings()">getPlayerSettings</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the player settings</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/IPlayer.html#setHand(jrummikub.model.IHand)">setHand</A></B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand)</CODE>
|
||||
|
||||
<BR>
|
||||
Set the current hand of the player</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/IPlayer.html#setLaidOut(boolean)">setLaidOut</A></B>(boolean laidOut)</CODE>
|
||||
|
||||
<BR>
|
||||
Set if the player laid out</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/IPlayer.html#setLastTurnInvalid(boolean)">setLastTurnInvalid</A></B>(boolean value)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets last turn invalid</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/IPlayer.html#setLastTurnStoneCount(int)">setLastTurnStoneCount</A></B>(int value)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the number of stones out on the table in player's last turn</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/IPlayer.html#wasLastTurnInvalid()">wasLastTurnInvalid</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Getter for last turn invalid</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
@ -162,36 +213,143 @@ getHand</H3>
|
|||
<DD>Get the current hand of the player
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the player's hand</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getColor()"><!-- --></A><H3>
|
||||
getColor</H3>
|
||||
<A NAME="setHand(jrummikub.model.IHand)"><!-- --></A><H3>
|
||||
setHand</H3>
|
||||
<PRE>
|
||||
java.awt.Color <B>getColor</B>()</PRE>
|
||||
void <B>setHand</B>(<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A> hand)</PRE>
|
||||
<DL>
|
||||
<DD>Return the player's color
|
||||
<DD>Set the current hand of the player
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the player's color</DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>hand</CODE> - the new hand</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getName()"><!-- --></A><H3>
|
||||
getName</H3>
|
||||
<A NAME="getLaidOut()"><!-- --></A><H3>
|
||||
getLaidOut</H3>
|
||||
<PRE>
|
||||
java.lang.String <B>getName</B>()</PRE>
|
||||
boolean <B>getLaidOut</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Return the name of the player
|
||||
<DD>Has the player laid out yet?
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the player's name</DL>
|
||||
<DT><B>Returns:</B><DD>if the player has laid out</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPlayerSettings()"><!-- --></A><H3>
|
||||
getPlayerSettings</H3>
|
||||
<PRE>
|
||||
<A HREF="../../jrummikub/model/PlayerSettings.html" title="class in jrummikub.model">PlayerSettings</A> <B>getPlayerSettings</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the player settings
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>the player settings</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLaidOut(boolean)"><!-- --></A><H3>
|
||||
setLaidOut</H3>
|
||||
<PRE>
|
||||
void <B>setLaidOut</B>(boolean laidOut)</PRE>
|
||||
<DL>
|
||||
<DD>Set if the player laid out
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>laidOut</CODE> - the player laid out</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="wasLastTurnInvalid()"><!-- --></A><H3>
|
||||
wasLastTurnInvalid</H3>
|
||||
<PRE>
|
||||
boolean <B>wasLastTurnInvalid</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Getter for last turn invalid
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>last turn invalid</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLastTurnInvalid(boolean)"><!-- --></A><H3>
|
||||
setLastTurnInvalid</H3>
|
||||
<PRE>
|
||||
void <B>setLastTurnInvalid</B>(boolean value)</PRE>
|
||||
<DL>
|
||||
<DD>Sets last turn invalid
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - last turn invalid</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLastTurnStoneCount()"><!-- --></A><H3>
|
||||
getLastTurnStoneCount</H3>
|
||||
<PRE>
|
||||
int <B>getLastTurnStoneCount</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Gets the number of stones put on table in player's last turn
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>number of stones</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLastTurnStoneCount(int)"><!-- --></A><H3>
|
||||
setLastTurnStoneCount</H3>
|
||||
<PRE>
|
||||
void <B>setLastTurnStoneCount</B>(int value)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the number of stones out on the table in player's last turn
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>value</CODE> - number of stones</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
|
@ -226,7 +384,7 @@ java.lang.String <B>getName</B>()</PRE>
|
|||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<A HREF="../../jrummikub/model/IRoundState.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/IPlayer.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="IPlayer.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
|
Reference in a new issue