diff options
Diffstat (limited to 'doc/jrummikub/model/IStoneTray.html')
| -rw-r--r-- | doc/jrummikub/model/IStoneTray.html | 337 |
1 files changed, 337 insertions, 0 deletions
diff --git a/doc/jrummikub/model/IStoneTray.html b/doc/jrummikub/model/IStoneTray.html new file mode 100644 index 0000000..89b891b --- /dev/null +++ b/doc/jrummikub/model/IStoneTray.html @@ -0,0 +1,337 @@ +<!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_20) on Tue May 10 16:57:32 CEST 2011 --> +<TITLE> +IStoneTray +</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="IStoneTray"; + } +} +</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/IStoneTray.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"> + <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/model/ITable.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/IStoneTray.html" target="_top"><B>FRAMES</B></A> + <A HREF="IStoneTray.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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> +Interface IStoneTray<E extends <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A>></H2> +<DL> +<DT><DT><B>Type Parameters:</B><DD><CODE>E</CODE> - Objects held by the IStoneTray</DL> +<DL> +<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><E,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>></DD> +</DL> +<DL> +<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../jrummikub/model/IHand.html" title="interface in jrummikub.model">IHand</A>, <A HREF="../../jrummikub/model/ITable.html" title="interface in jrummikub.model">ITable</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../jrummikub/model/Hand.html" title="class in jrummikub.model">Hand</A>, <A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model">StoneTray</A>, <A HREF="../../jrummikub/model/Table.html" title="class in jrummikub.model">Table</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>IStoneTray<E extends <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A>></B><DT>extends java.lang.Iterable<<A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><E,<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A>>>, java.lang.Cloneable</DL> +</PRE> + +<P> +Interface for the <A HREF="../../jrummikub/model/StoneTray.html" title="class in jrummikub.model"><CODE>StoneTray</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> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A>></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../jrummikub/model/IStoneTray.html#clone()">clone</A></B>()</CODE> + +<BR> + Create a clone of the StoneTray</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/IStoneTray.html#drop(E, jrummikub.model.Position)">drop</A></B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object, + <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> position)</CODE> + +<BR> + Adds object to the tray</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../jrummikub/model/IStoneTray.html#getPosition(E)">getPosition</A></B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object)</CODE> + +<BR> + Returns the position of an object that is already on the tray</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/IStoneTray.html#getSize()">getSize</A></B>()</CODE> + +<BR> + Return the number of objects on the tray</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/IStoneTray.html#pickUp(E)">pickUp</A></B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object)</CODE> + +<BR> + Tries to pick up (remove) a given object</TD> +</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> + +<!-- ============ 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="drop(jrummikub.model.Sizeable,jrummikub.model.Position)"><!-- --></A><A NAME="drop(E, jrummikub.model.Position)"><!-- --></A><H3> +drop</H3> +<PRE> +void <B>drop</B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object, + <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> position)</PRE> +<DL> +<DD>Adds object to the tray +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - object to add to Hand<DD><CODE>position</CODE> - <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model"><CODE>Position</CODE></A> to put the object</DL> +</DD> +</DL> +<HR> + +<A NAME="getPosition(jrummikub.model.Sizeable)"><!-- --></A><A NAME="getPosition(E)"><!-- --></A><H3> +getPosition</H3> +<PRE> +<A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model">Position</A> <B>getPosition</B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object)</PRE> +<DL> +<DD>Returns the position of an object that is already on the tray +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - object whose position is requested +<DT><B>Returns:</B><DD>position of the object or null when the object is not on the tray</DL> +</DD> +</DL> +<HR> + +<A NAME="pickUp(jrummikub.model.Sizeable)"><!-- --></A><A NAME="pickUp(E)"><!-- --></A><H3> +pickUp</H3> +<PRE> +boolean <B>pickUp</B>(<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A> object)</PRE> +<DL> +<DD>Tries to pick up (remove) a given object +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>object</CODE> - object to pick up +<DT><B>Returns:</B><DD>true when the object was successfully removed</DL> +</DD> +</DL> +<HR> + +<A NAME="clone()"><!-- --></A><H3> +clone</H3> +<PRE> +<A HREF="../../jrummikub/model/IStoneTray.html" title="interface in jrummikub.model">IStoneTray</A><<A HREF="../../jrummikub/model/IStoneTray.html" title="type parameter in IStoneTray">E</A>> <B>clone</B>()</PRE> +<DL> +<DD>Create a clone of the StoneTray +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>cloned StoneTray</DL> +</DD> +</DL> +<HR> + +<A NAME="getSize()"><!-- --></A><H3> +getSize</H3> +<PRE> +int <B>getSize</B>()</PRE> +<DL> +<DD>Return the number of objects on the tray +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> + +<DT><B>Returns:</B><DD>number of objects</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/IStoneTray.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"> + <A HREF="../../jrummikub/model/IPlayer.html" title="interface in jrummikub.model"><B>PREV CLASS</B></A> + <A HREF="../../jrummikub/model/ITable.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/IStoneTray.html" target="_top"><B>FRAMES</B></A> + <A HREF="IStoneTray.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |