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:58 CEST 2011 -->
|
||||
<!-- Generated by javadoc (build 1.6.0_22) on Tue Jul 05 21:51:55 CEST 2011 -->
|
||||
<TITLE>
|
||||
Table
|
||||
</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/StoneTray.Direction.html" title="enum in jrummikub.model"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<A HREF="../../jrummikub/model/Table.StoneInfo.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/Table.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Table.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
@ -76,9 +76,9 @@ function windowTitle()
|
|||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_jrummikub.model.StoneTray">NESTED</A> | <A HREF="#fields_inherited_from_class_jrummikub.model.StoneTray">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <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>
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
|
@ -97,7 +97,7 @@ java.lang.Object
|
|||
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.Table</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>>, <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>>, <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A></DD>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>>, <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A>>, <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
|
@ -109,6 +109,8 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#jrummikub.model.Table">Serialized Form</A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
@ -120,6 +122,14 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Nested Class Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private static class</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.StoneInfo.html" title="class in jrummikub.model">Table.StoneInfo</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="nested_classes_inherited_from_class_jrummikub.model.StoneTray"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
|
@ -139,6 +149,22 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<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 <A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#gameSettings">gameSettings</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private static long</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#serialVersionUID">serialVersionUID</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="fields_inherited_from_class_jrummikub.model.StoneTray"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
|
@ -159,10 +185,10 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<B>Constructor Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#Table()">Table</A></B>()</CODE>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#Table(jrummikub.model.GameSettings)">Table</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
Constructor for a table</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
|
@ -176,6 +202,14 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private <A HREF="../../jrummikub/model/Table.StoneInfo.html" title="class in jrummikub.model">Table.StoneInfo</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#findStoneInfo(jrummikub.model.Stone)">findStoneInfo</A></B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</CODE>
|
||||
|
||||
<BR>
|
||||
Finds <A HREF="../../jrummikub/model/Table.StoneInfo.html" title="class in jrummikub.model"><CODE>Table.StoneInfo</CODE></A></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#findStoneSet(jrummikub.model.Stone)">findStoneSet</A></B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</CODE>
|
||||
|
||||
|
@ -198,6 +232,16 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<BR>
|
||||
Removes <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model"><CODE>Stone</CODE></A> from the Table</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>private void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../jrummikub/model/Table.html#splitSet(jrummikub.model.StoneSet, jrummikub.model.Position, int)">splitSet</A></B>(<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A> set,
|
||||
<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> setPosition,
|
||||
int stonePosition)</CODE>
|
||||
|
||||
<BR>
|
||||
Splits a stone set at a specified position</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_jrummikub.model.StoneTray"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
|
@ -205,7 +249,7 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<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#drop(E, jrummikub.model.Position)">drop</A>, <A HREF="../../jrummikub/model/StoneTray.html#fixInvalidDrop(E, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)">fixInvalidDrop</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>
|
||||
<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#fixInvalidDrop(E, jrummikub.model.Position, jrummikub.model.StoneTray.Direction)">fixInvalidDrop</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>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
|
@ -223,7 +267,7 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
<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>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Iterable"><!-- --></A>
|
||||
|
@ -238,6 +282,35 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
|
||||
<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.Table.serialVersionUID">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="gameSettings"><!-- --></A><H3>
|
||||
gameSettings</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> <B>gameSettings</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
</DL>
|
||||
</DL>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
|
@ -248,11 +321,15 @@ Class administering the <A HREF="../../jrummikub/model/Stone.html" title="class
|
|||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="Table()"><!-- --></A><H3>
|
||||
<A NAME="Table(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
||||
Table</H3>
|
||||
<PRE>
|
||||
public <B>Table</B>()</PRE>
|
||||
public <B>Table</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
||||
<DL>
|
||||
<DD>Constructor for a table
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - GameSettings</DL>
|
||||
</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
@ -281,6 +358,23 @@ public void <B>pickUpStone</B>(<A HREF="../../jrummikub/model/Stone.html" title=
|
|||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="findStoneInfo(jrummikub.model.Stone)"><!-- --></A><H3>
|
||||
findStoneInfo</H3>
|
||||
<PRE>
|
||||
private <A HREF="../../jrummikub/model/Table.StoneInfo.html" title="class in jrummikub.model">Table.StoneInfo</A> <B>findStoneInfo</B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</PRE>
|
||||
<DL>
|
||||
<DD>Finds <A HREF="../../jrummikub/model/Table.StoneInfo.html" title="class in jrummikub.model"><CODE>Table.StoneInfo</CODE></A>
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>stone</CODE> - the stone
|
||||
<DT><B>Returns:</B><DD>the info</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="findStoneSet(jrummikub.model.Stone)"><!-- --></A><H3>
|
||||
findStoneSet</H3>
|
||||
<PRE>
|
||||
|
@ -299,6 +393,24 @@ public <A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.m
|
|||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="splitSet(jrummikub.model.StoneSet, jrummikub.model.Position, int)"><!-- --></A><H3>
|
||||
splitSet</H3>
|
||||
<PRE>
|
||||
private void <B>splitSet</B>(<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A> set,
|
||||
<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> setPosition,
|
||||
int stonePosition)</PRE>
|
||||
<DL>
|
||||
<DD>Splits a stone set at a specified position
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>set</CODE> - the stone set to split<DD><CODE>setPosition</CODE> - the set's position on the table<DD><CODE>stonePosition</CODE> - the stone after which splitting should occur</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="isValid()"><!-- --></A><H3>
|
||||
isValid</H3>
|
||||
<PRE>
|
||||
|
@ -346,7 +458,7 @@ public boolean <B>isValid</B>()</PRE>
|
|||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../jrummikub/model/StoneTray.Direction.html" title="enum in jrummikub.model"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<A HREF="../../jrummikub/model/Table.StoneInfo.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/Table.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="Table.html" target="_top"><B>NO FRAMES</B></A>
|
||||
|
@ -366,9 +478,9 @@ public boolean <B>isValid</B>()</PRE>
|
|||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: <A HREF="#nested_classes_inherited_from_class_jrummikub.model.StoneTray">NESTED</A> | <A HREF="#fields_inherited_from_class_jrummikub.model.StoneTray">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <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>
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
|
|
Reference in a new issue