2011-05-10 16:59:40 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< HTML >
< HEAD >
2011-05-10 17:05:58 +02:00
<!-- Generated by javadoc (build 1.6.0_22) on Tue May 10 17:04:58 CEST 2011 -->
2011-05-10 16:59:40 +02:00
< TITLE >
StoneHeap
< / 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="StoneHeap";
}
}
< / 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/StoneHeap.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/StoneColor.html" title = "enum in jrummikub.model" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../jrummikub/model/StoneSet.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/StoneHeap.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "StoneHeap.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 | < 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 StoneHeap< / H2 >
< PRE >
java.lang.Object
< IMG SRC = "../../resources/inherit.gif" ALT = "extended by " > < B > jrummikub.model.StoneHeap< / B >
< / PRE >
< HR >
< DL >
< DT > < PRE > public class < B > StoneHeap< / B > < DT > extends java.lang.Object< / DL >
< / PRE >
< P >
StoneHeap creates all < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > < CODE > Stone< / CODE > < / A > s for a game, manages them and allows
players to draw one or more random Stones.
< P >
< P >
< HR >
< P >
<!-- =========== 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) java.util.List< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/StoneHeap.html#heap" > heap< / 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/StoneHeap.html#StoneHeap()" > StoneHeap< / A > < / B > ()< / CODE >
< BR >
Creates 106 Stones according to standard rules< / 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/Stone.html" title = "class in jrummikub.model" > Stone< / A > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/StoneHeap.html#drawStone()" > drawStone< / A > < / B > ()< / CODE >
< BR >
Removes random < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > < CODE > Stone< / CODE > < / A > from the heap and returns it< / TD >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > java.util.List< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > < / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../jrummikub/model/StoneHeap.html#drawStones(int)" > drawStones< / A > < / B > (int number)< / CODE >
< BR >
Removes several < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > < CODE > Stone< / CODE > < / A > s from the heap and returns them< / 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/StoneHeap.html#getSize()" > getSize< / A > < / B > ()< / CODE >
< BR >
Get the number of stones left< / 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/StoneHeap.html#putBack(java.util.Collection)" > putBack< / A > < / B > (java.util.Collection< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > stones)< / CODE >
< BR >
Put stones back on the heap< / 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 >
<!-- ============ 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 = "heap" > <!-- --> < / A > < H3 >
heap< / H3 >
< PRE >
java.util.List< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > < B > heap< / 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 = "StoneHeap()" > <!-- --> < / A > < H3 >
StoneHeap< / H3 >
< PRE >
public < B > StoneHeap< / B > ()< / PRE >
< DL >
< DD > Creates 106 Stones according to standard rules
< 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 = "drawStone()" > <!-- --> < / A > < H3 >
drawStone< / H3 >
< PRE >
public < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > < B > drawStone< / B > ()< / PRE >
< DL >
< DD > Removes random < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > < CODE > Stone< / CODE > < / A > from the heap and returns it
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > the drawn stone< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "drawStones(int)" > <!-- --> < / A > < H3 >
drawStones< / H3 >
< PRE >
public java.util.List< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > < B > drawStones< / B > (int number)< / PRE >
< DL >
< DD > Removes several < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > < CODE > Stone< / CODE > < / A > s from the heap and returns them
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > number< / CODE > - number of requested Stones
< DT > < B > Returns:< / B > < DD > list of drawn stones< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "getSize()" > <!-- --> < / A > < H3 >
getSize< / H3 >
< PRE >
public int < B > getSize< / B > ()< / PRE >
< DL >
< DD > Get the number of stones left
< P >
< DD > < DL >
< DT > < B > Returns:< / B > < DD > number of stones on the heap< / DL >
< / DD >
< / DL >
< HR >
< A NAME = "putBack(java.util.Collection)" > <!-- --> < / A > < H3 >
putBack< / H3 >
< PRE >
public void < B > putBack< / B > (java.util.Collection< < A HREF = "../../jrummikub/model/Stone.html" title = "class in jrummikub.model" > Stone< / A > > stones)< / PRE >
< DL >
< DD > Put stones back on the heap
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > stones< / CODE > - collection of stones to put back< / 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/StoneHeap.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/StoneColor.html" title = "enum in jrummikub.model" > < B > PREV CLASS< / B > < / A >
< A HREF = "../../jrummikub/model/StoneSet.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/StoneHeap.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "StoneHeap.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 | < 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 >
