51b7fbe822
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@609 72836036-5685-4462-b002-a69064685172
702 lines
28 KiB
HTML
702 lines
28 KiB
HTML
<!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 Jul 05 21:51:55 CEST 2011 -->
|
|
<TITLE>
|
|
StoneSet
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2011-07-05">
|
|
|
|
<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="StoneSet";
|
|
}
|
|
}
|
|
</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/StoneSet.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/StoneHeap.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>
|
|
<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?jrummikub/model/StoneSet.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="StoneSet.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: <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: <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>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
jrummikub.model</FONT>
|
|
<BR>
|
|
Class StoneSet</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>jrummikub.model.StoneSet</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>StoneSet</B><DT>extends java.lang.Object<DT>implements java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>>, <A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A>, java.io.Serializable</DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Class managing <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model"><CODE>Stone</CODE></A>s joined together to form sets
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#jrummikub.model.StoneSet">Serialized Form</A></DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A></B></CODE>
|
|
|
|
<BR>
|
|
Validity type of the set</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_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>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>(package private) static float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#HORIZONTAL_BORDER">HORIZONTAL_BORDER</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/StoneSet.html#serialVersionUID">serialVersionUID</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>private java.util.ArrayList<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#stones">stones</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>(package private) static float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#VERTICAL_BORDER">VERTICAL_BORDER</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== 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/StoneSet.html#StoneSet(java.util.List)">StoneSet</A></B>(java.util.List<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> stones)</CODE>
|
|
|
|
<BR>
|
|
Create a stone set from a list of stones</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#StoneSet(jrummikub.model.Stone)">StoneSet</A></B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</CODE>
|
|
|
|
<BR>
|
|
Create a new single stone stone set</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/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#classify(jrummikub.model.GameSettings)">classify</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
|
|
|
<BR>
|
|
Test for rule conflict within the StoneSet and determine whether the set is
|
|
a group or a run</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>private <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#classifyJokersOnly(jrummikub.model.GameSettings)">classifyJokersOnly</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
|
|
|
<BR>
|
|
Test for rule conflict within a StoneSet with jokers only and determine
|
|
whether the set is a group or a run</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#get(int)">get</A></B>(int i)</CODE>
|
|
|
|
<BR>
|
|
Returns the i-th stone of the set (starting with 0)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#getHeight()">getHeight</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the height of the object</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/StoneSet.html#getSize()">getSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the number of stones in the set.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#getWidth()">getWidth</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the width of the object</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/StoneSet.html#isValid(jrummikub.model.GameSettings)">isValid</A></B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
|
|
|
<BR>
|
|
Test for rule conflict within the StoneSet</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>private int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValidGroup(int, jrummikub.model.GameSettings)">isValidGroup</A></B>(int value,
|
|
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
|
|
|
<BR>
|
|
Test for rule conflict within the StoneSet, assuming we have a group</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>private int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#isValidRun(int, jrummikub.model.GameSettings)">isValidRun</A></B>(int referencePosition,
|
|
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</CODE>
|
|
|
|
<BR>
|
|
Test for rule conflict within the StoneSet, assuming we have a run</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.Iterator<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#iterator()">iterator</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</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/StoneSet.html#join(jrummikub.model.StoneSet)">join</A></B>(<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A> other)</CODE>
|
|
|
|
<BR>
|
|
Joins StoneSet to another StoneSet and returns the resulting new StoneSet</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <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/StoneSet.html" title="class in jrummikub.model">StoneSet</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../jrummikub/model/StoneSet.html#splitAt(int)">splitAt</A></B>(int position)</CODE>
|
|
|
|
<BR>
|
|
Splits the StoneSet at a specified <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model"><CODE>Position</CODE></A> and returns two new
|
|
Stone Sets</TD>
|
|
</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/StoneSet.html#toString()">toString</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</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, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<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.StoneSet.serialVersionUID">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="VERTICAL_BORDER"><!-- --></A><H3>
|
|
VERTICAL_BORDER</H3>
|
|
<PRE>
|
|
static final float <B>VERTICAL_BORDER</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#jrummikub.model.StoneSet.VERTICAL_BORDER">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="HORIZONTAL_BORDER"><!-- --></A><H3>
|
|
HORIZONTAL_BORDER</H3>
|
|
<PRE>
|
|
static final float <B>HORIZONTAL_BORDER</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#jrummikub.model.StoneSet.HORIZONTAL_BORDER">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="stones"><!-- --></A><H3>
|
|
stones</H3>
|
|
<PRE>
|
|
private java.util.ArrayList<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> <B>stones</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ========= 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="StoneSet(jrummikub.model.Stone)"><!-- --></A><H3>
|
|
StoneSet</H3>
|
|
<PRE>
|
|
public <B>StoneSet</B>(<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> stone)</PRE>
|
|
<DL>
|
|
<DD>Create a new single stone stone set
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>stone</CODE> - single stone of the set</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="StoneSet(java.util.List)"><!-- --></A><H3>
|
|
StoneSet</H3>
|
|
<PRE>
|
|
public <B>StoneSet</B>(java.util.List<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> stones)</PRE>
|
|
<DL>
|
|
<DD>Create a stone set from a list of stones
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>stones</CODE> - list of stones to build a set of</DL>
|
|
</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="isValid(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
|
isValid</H3>
|
|
<PRE>
|
|
public boolean <B>isValid</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
|
<DL>
|
|
<DD>Test for rule conflict within the StoneSet
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - GameSettings
|
|
<DT><B>Returns:</B><DD>true when the set is valid according to the rules</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="classify(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
|
classify</H3>
|
|
<PRE>
|
|
public <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer> <B>classify</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
|
<DL>
|
|
<DD>Test for rule conflict within the StoneSet and determine whether the set is
|
|
a group or a run
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - GameSettings
|
|
<DT><B>Returns:</B><DD>GROUP or RUN for valid sets, INVALID otherwise and the points</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="classifyJokersOnly(jrummikub.model.GameSettings)"><!-- --></A><H3>
|
|
classifyJokersOnly</H3>
|
|
<PRE>
|
|
private <A HREF="../../jrummikub/util/Pair.html" title="class in jrummikub.util">Pair</A><<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model">StoneSet.Type</A>,java.lang.Integer> <B>classifyJokersOnly</B>(<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
|
<DL>
|
|
<DD>Test for rule conflict within a StoneSet with jokers only and determine
|
|
whether the set is a group or a run
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the game settings
|
|
<DT><B>Returns:</B><DD>GROUP or RUN for valid sets, INVALID otherwise and the points</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isValidRun(int, jrummikub.model.GameSettings)"><!-- --></A><H3>
|
|
isValidRun</H3>
|
|
<PRE>
|
|
private int <B>isValidRun</B>(int referencePosition,
|
|
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
|
<DL>
|
|
<DD>Test for rule conflict within the StoneSet, assuming we have a run
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>referencePosition</CODE> - position of stone used as reference (any non-joker stone)<DD><CODE>settings</CODE> - the game settings
|
|
<DT><B>Returns:</B><DD>the set's points</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isValidGroup(int, jrummikub.model.GameSettings)"><!-- --></A><H3>
|
|
isValidGroup</H3>
|
|
<PRE>
|
|
private int <B>isValidGroup</B>(int value,
|
|
<A HREF="../../jrummikub/model/GameSettings.html" title="class in jrummikub.model">GameSettings</A> settings)</PRE>
|
|
<DL>
|
|
<DD>Test for rule conflict within the StoneSet, assuming we have a group
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of the stones (all have the same in a group)<DD><CODE>settings</CODE> - the game settings
|
|
<DT><B>Returns:</B><DD>the set's points</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="splitAt(int)"><!-- --></A><H3>
|
|
splitAt</H3>
|
|
<PRE>
|
|
public <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/StoneSet.html" title="class in jrummikub.model">StoneSet</A>> <B>splitAt</B>(int position)</PRE>
|
|
<DL>
|
|
<DD>Splits the StoneSet at a specified <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model"><CODE>Position</CODE></A> and returns two new
|
|
Stone Sets
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>position</CODE> - Splitting <A HREF="../../jrummikub/model/Position.html" title="class in jrummikub.model"><CODE>Position</CODE></A>
|
|
<DT><B>Returns:</B><DD>A pair of StoneSets, one for each split part</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="join(jrummikub.model.StoneSet)"><!-- --></A><H3>
|
|
join</H3>
|
|
<PRE>
|
|
public <A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A> <B>join</B>(<A HREF="../../jrummikub/model/StoneSet.html" title="class in jrummikub.model">StoneSet</A> other)</PRE>
|
|
<DL>
|
|
<DD>Joins StoneSet to another StoneSet and returns the resulting new StoneSet
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>other</CODE> - StoneSet to be joined to active StoneSet
|
|
<DT><B>Returns:</B><DD>the combined StoneSet</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSize()"><!-- --></A><H3>
|
|
getSize</H3>
|
|
<PRE>
|
|
public int <B>getSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns the number of stones in the set.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>number of stones</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="get(int)"><!-- --></A><H3>
|
|
get</H3>
|
|
<PRE>
|
|
public <A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A> <B>get</B>(int i)</PRE>
|
|
<DL>
|
|
<DD>Returns the i-th stone of the set (starting with 0)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>i</CODE> - number of the stone to return
|
|
<DT><B>Returns:</B><DD>the i-th stone</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="iterator()"><!-- --></A><H3>
|
|
iterator</H3>
|
|
<PRE>
|
|
public java.util.Iterator<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>> <B>iterator</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.lang.Iterable<<A HREF="../../jrummikub/model/Stone.html" title="class in jrummikub.model">Stone</A>></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getWidth()"><!-- --></A><H3>
|
|
getWidth</H3>
|
|
<PRE>
|
|
public float <B>getWidth</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/Sizeable.html#getWidth()">Sizeable</A></CODE></B></DD>
|
|
<DD>Get the width of the object
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/Sizeable.html#getWidth()">getWidth</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>object width</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getHeight()"><!-- --></A><H3>
|
|
getHeight</H3>
|
|
<PRE>
|
|
public float <B>getHeight</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Description copied from interface: <CODE><A HREF="../../jrummikub/model/Sizeable.html#getHeight()">Sizeable</A></CODE></B></DD>
|
|
<DD>Get the height of the object
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../jrummikub/model/Sizeable.html#getHeight()">getHeight</A></CODE> in interface <CODE><A HREF="../../jrummikub/model/Sizeable.html" title="interface in jrummikub.model">Sizeable</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>object height</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="toString()"><!-- --></A><H3>
|
|
toString</H3>
|
|
<PRE>
|
|
public java.lang.String <B>toString</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</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/StoneSet.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/StoneHeap.html" title="class in jrummikub.model"><B>PREV CLASS</B></A>
|
|
<A HREF="../../jrummikub/model/StoneSet.Type.html" title="enum in jrummikub.model"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?jrummikub/model/StoneSet.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="StoneSet.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: <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: <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>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|