From 670fcf2613f6db2a4bfdaa91ac9d90001a90359e Mon Sep 17 00:00:00 2001 From: Ida Massow Date: Tue, 10 May 2011 16:59:40 +0200 Subject: docs fertig und vorher repariert git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@232 72836036-5685-4462-b002-a69064685172 --- doc/jrummikub/model/GameState.html | 422 +++++++++++++++ doc/jrummikub/model/Hand.html | 386 +++++++++++++ doc/jrummikub/model/IGameState.html | 346 ++++++++++++ doc/jrummikub/model/IHand.html | 206 +++++++ doc/jrummikub/model/IPlayer.html | 260 +++++++++ doc/jrummikub/model/IStoneTray.html | 337 ++++++++++++ doc/jrummikub/model/ITable.html | 289 ++++++++++ doc/jrummikub/model/Player.html | 324 +++++++++++ doc/jrummikub/model/Position.html | 354 ++++++++++++ doc/jrummikub/model/Sizeable.html | 240 +++++++++ doc/jrummikub/model/Stone.html | 414 ++++++++++++++ doc/jrummikub/model/StoneColor.html | 358 +++++++++++++ doc/jrummikub/model/StoneHeap.html | 363 +++++++++++++ doc/jrummikub/model/StoneSet.Type.html | 351 ++++++++++++ doc/jrummikub/model/StoneSet.html | 583 ++++++++++++++++++++ doc/jrummikub/model/StoneTray.Direction.html | 361 +++++++++++++ doc/jrummikub/model/StoneTray.html | 483 +++++++++++++++++ doc/jrummikub/model/Table.html | 380 +++++++++++++ doc/jrummikub/model/class-use/GameState.html | 144 +++++ doc/jrummikub/model/class-use/Hand.html | 144 +++++ doc/jrummikub/model/class-use/IGameState.html | 208 ++++++++ doc/jrummikub/model/class-use/IHand.html | 243 +++++++++ doc/jrummikub/model/class-use/IPlayer.html | 220 ++++++++ doc/jrummikub/model/class-use/IStoneTray.html | 245 +++++++++ doc/jrummikub/model/class-use/ITable.html | 284 ++++++++++ doc/jrummikub/model/class-use/Player.html | 144 +++++ doc/jrummikub/model/class-use/Position.html | 526 ++++++++++++++++++ doc/jrummikub/model/class-use/Sizeable.html | 213 ++++++++ doc/jrummikub/model/class-use/Stone.html | 594 +++++++++++++++++++++ doc/jrummikub/model/class-use/StoneColor.html | 218 ++++++++ doc/jrummikub/model/class-use/StoneHeap.html | 188 +++++++ doc/jrummikub/model/class-use/StoneSet.Type.html | 198 +++++++ doc/jrummikub/model/class-use/StoneSet.html | 346 ++++++++++++ .../model/class-use/StoneTray.Direction.html | 247 +++++++++ doc/jrummikub/model/class-use/StoneTray.html | 188 +++++++ doc/jrummikub/model/class-use/Table.html | 144 +++++ doc/jrummikub/model/package-frame.html | 84 +++ doc/jrummikub/model/package-summary.html | 248 +++++++++ doc/jrummikub/model/package-tree.html | 187 +++++++ doc/jrummikub/model/package-use.html | 359 +++++++++++++ 40 files changed, 11829 insertions(+) create mode 100644 doc/jrummikub/model/GameState.html create mode 100644 doc/jrummikub/model/Hand.html create mode 100644 doc/jrummikub/model/IGameState.html create mode 100644 doc/jrummikub/model/IHand.html create mode 100644 doc/jrummikub/model/IPlayer.html create mode 100644 doc/jrummikub/model/IStoneTray.html create mode 100644 doc/jrummikub/model/ITable.html create mode 100644 doc/jrummikub/model/Player.html create mode 100644 doc/jrummikub/model/Position.html create mode 100644 doc/jrummikub/model/Sizeable.html create mode 100644 doc/jrummikub/model/Stone.html create mode 100644 doc/jrummikub/model/StoneColor.html create mode 100644 doc/jrummikub/model/StoneHeap.html create mode 100644 doc/jrummikub/model/StoneSet.Type.html create mode 100644 doc/jrummikub/model/StoneSet.html create mode 100644 doc/jrummikub/model/StoneTray.Direction.html create mode 100644 doc/jrummikub/model/StoneTray.html create mode 100644 doc/jrummikub/model/Table.html create mode 100644 doc/jrummikub/model/class-use/GameState.html create mode 100644 doc/jrummikub/model/class-use/Hand.html create mode 100644 doc/jrummikub/model/class-use/IGameState.html create mode 100644 doc/jrummikub/model/class-use/IHand.html create mode 100644 doc/jrummikub/model/class-use/IPlayer.html create mode 100644 doc/jrummikub/model/class-use/IStoneTray.html create mode 100644 doc/jrummikub/model/class-use/ITable.html create mode 100644 doc/jrummikub/model/class-use/Player.html create mode 100644 doc/jrummikub/model/class-use/Position.html create mode 100644 doc/jrummikub/model/class-use/Sizeable.html create mode 100644 doc/jrummikub/model/class-use/Stone.html create mode 100644 doc/jrummikub/model/class-use/StoneColor.html create mode 100644 doc/jrummikub/model/class-use/StoneHeap.html create mode 100644 doc/jrummikub/model/class-use/StoneSet.Type.html create mode 100644 doc/jrummikub/model/class-use/StoneSet.html create mode 100644 doc/jrummikub/model/class-use/StoneTray.Direction.html create mode 100644 doc/jrummikub/model/class-use/StoneTray.html create mode 100644 doc/jrummikub/model/class-use/Table.html create mode 100644 doc/jrummikub/model/package-frame.html create mode 100644 doc/jrummikub/model/package-summary.html create mode 100644 doc/jrummikub/model/package-tree.html create mode 100644 doc/jrummikub/model/package-use.html (limited to 'doc/jrummikub/model') diff --git a/doc/jrummikub/model/GameState.html b/doc/jrummikub/model/GameState.html new file mode 100644 index 0000000..efc47e6 --- /dev/null +++ b/doc/jrummikub/model/GameState.html @@ -0,0 +1,422 @@ + + + + + + +GameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class GameState

+
+java.lang.Object
+  extended by jrummikub.model.GameState
+
+
+
All Implemented Interfaces:
IGameState
+
+
+
+
public class GameState
extends java.lang.Object
implements IGameState
+ + +

+Class managing the overall and momentary GameState +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
GameState() + +
+          Create a new GameState with an empty table and (currently) 4 new players.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IPlayergetActivePlayer() + +
+          Returns the currently active player
+ StoneHeapgetGameHeap() + +
+          Returns the heap of stones to draw from
+ IPlayergetNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+ intgetPlayerCount() + +
+          Returns the number of players
+ ITablegetTable() + +
+          Get the current Table
+ voidnextPlayer() + +
+          Changes the activePlayer to the next Player in the list
+ voidsetTable(ITable table) + +
+          Sets the current Table
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+GameState

+
+public GameState()
+
+
Create a new GameState with an empty table and (currently) 4 new players. +

+

+ + + + + + + + +
+Method Detail
+ +

+getTable

+
+public ITable getTable()
+
+
Description copied from interface: IGameState
+
Get the current Table +

+

+
Specified by:
getTable in interface IGameState
+
+
+ +
Returns:
The current Table
+
+
+
+ +

+setTable

+
+public void setTable(ITable table)
+
+
Description copied from interface: IGameState
+
Sets the current Table +

+

+
Specified by:
setTable in interface IGameState
+
+
+
Parameters:
table - The new Table
+
+
+
+ +

+getPlayerCount

+
+public int getPlayerCount()
+
+
Description copied from interface: IGameState
+
Returns the number of players +

+

+
Specified by:
getPlayerCount in interface IGameState
+
+
+ +
Returns:
number of players
+
+
+
+ +

+nextPlayer

+
+public void nextPlayer()
+
+
Description copied from interface: IGameState
+
Changes the activePlayer to the next Player in the list +

+

+
Specified by:
nextPlayer in interface IGameState
+
+
+
+
+
+
+ +

+getNthNextPlayer

+
+public IPlayer getNthNextPlayer(int i)
+
+
Description copied from interface: IGameState
+
Returns the player that would be the active player after i turns +

+

+
Specified by:
getNthNextPlayer in interface IGameState
+
+
+
Parameters:
i - number of turns +
Returns:
player active after i turns
+
+
+
+ +

+getActivePlayer

+
+public IPlayer getActivePlayer()
+
+
Description copied from interface: IGameState
+
Returns the currently active player +

+

+
Specified by:
getActivePlayer in interface IGameState
+
+
+ +
Returns:
currently active player
+
+
+
+ +

+getGameHeap

+
+public StoneHeap getGameHeap()
+
+
Description copied from interface: IGameState
+
Returns the heap of stones to draw from +

+

+
Specified by:
getGameHeap in interface IGameState
+
+
+ +
Returns:
heap of stones
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Hand.html b/doc/jrummikub/model/Hand.html new file mode 100644 index 0000000..678c2f2 --- /dev/null +++ b/doc/jrummikub/model/Hand.html @@ -0,0 +1,386 @@ + + + + + + +Hand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class Hand

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<Stone>
+      extended by jrummikub.model.Hand
+
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<Stone,Position>>, IHand, IStoneTray<Stone>
+
+
+
+
public class Hand
extends StoneTray<Stone>
implements IHand
+ + +

+Class managing a Player's Stones +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class jrummikub.model.StoneTray
StoneTray.Direction
+  + + + + + + + + + + + + + + + +
+Field Summary
+static intHEIGHT + +
+          The height of the hand
+static intWIDTH + +
+          The width of the hand
+  + + + + + + + +
Fields inherited from class jrummikub.model.StoneTray
objects
+  + + + + + + + + + + +
+Constructor Summary
Hand() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  Pair<Position,StoneTray.Direction>fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+  + + + + + + + +
Methods inherited from class jrummikub.model.StoneTray
clone, drop, getPosition, getSize, iterator, pickUp
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Field Detail
+ +

+WIDTH

+
+public static final int WIDTH
+
+
The width of the hand +

+

+
See Also:
Constant Field Values
+
+
+ +

+HEIGHT

+
+public static final int HEIGHT
+
+
The height of the hand +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+Hand

+
+public Hand()
+
+
+ + + + + + + + +
+Method Detail
+ +

+fixInvalidDrop

+
+protected Pair<Position,StoneTray.Direction> fixInvalidDrop(Stone stone,
+                                                            Position pos,
+                                                            StoneTray.Direction dir)
+
+
Description copied from class: StoneTray
+
Checks whether the object may be placed on the given position, computes + new position if not +

+

+
Overrides:
fixInvalidDrop in class StoneTray<Stone>
+
+
+
Parameters:
stone - to be dropped
pos - the object is dropped at +
Returns:
null if the drop is valid, new position otherwise
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/IGameState.html b/doc/jrummikub/model/IGameState.html new file mode 100644 index 0000000..b18e2a2 --- /dev/null +++ b/doc/jrummikub/model/IGameState.html @@ -0,0 +1,346 @@ + + + + + + +IGameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface IGameState

+
+
All Known Implementing Classes:
GameState
+
+
+
+
public interface IGameState
+ + +

+Interface for GameState model +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IPlayergetActivePlayer() + +
+          Returns the currently active player
+ StoneHeapgetGameHeap() + +
+          Returns the heap of stones to draw from
+ IPlayergetNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+ intgetPlayerCount() + +
+          Returns the number of players
+ ITablegetTable() + +
+          Get the current Table
+ voidnextPlayer() + +
+          Changes the activePlayer to the next Player in the list
+ voidsetTable(ITable table) + +
+          Sets the current Table
+  +

+ + + + + + + + +
+Method Detail
+ +

+getTable

+
+ITable getTable()
+
+
Get the current Table +

+

+ +
Returns:
The current Table
+
+
+
+ +

+setTable

+
+void setTable(ITable table)
+
+
Sets the current Table +

+

+
Parameters:
table - The new Table
+
+
+
+ +

+getPlayerCount

+
+int getPlayerCount()
+
+
Returns the number of players +

+

+ +
Returns:
number of players
+
+
+
+ +

+nextPlayer

+
+void nextPlayer()
+
+
Changes the activePlayer to the next Player in the list +

+

+
+
+
+
+ +

+getActivePlayer

+
+IPlayer getActivePlayer()
+
+
Returns the currently active player +

+

+ +
Returns:
currently active player
+
+
+
+ +

+getGameHeap

+
+StoneHeap getGameHeap()
+
+
Returns the heap of stones to draw from +

+

+ +
Returns:
heap of stones
+
+
+
+ +

+getNthNextPlayer

+
+IPlayer getNthNextPlayer(int i)
+
+
Returns the player that would be the active player after i turns +

+

+
Parameters:
i - number of turns +
Returns:
player active after i turns
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/IHand.html b/doc/jrummikub/model/IHand.html new file mode 100644 index 0000000..5689921 --- /dev/null +++ b/doc/jrummikub/model/IHand.html @@ -0,0 +1,206 @@ + + + + + + +IHand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface IHand

+
+
All Superinterfaces:
java.lang.Cloneable, IStoneTray<Stone>, java.lang.Iterable<Pair<Stone,Position>>
+
+
+
All Known Implementing Classes:
Hand
+
+
+
+
public interface IHand
extends IStoneTray<Stone>
+ + +

+Interface for the Hand model +

+ +

+

+ +

+ + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/IPlayer.html b/doc/jrummikub/model/IPlayer.html new file mode 100644 index 0000000..f15bd4a --- /dev/null +++ b/doc/jrummikub/model/IPlayer.html @@ -0,0 +1,260 @@ + + + + + + +IPlayer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface IPlayer

+
+
All Known Implementing Classes:
Player
+
+
+
+
public interface IPlayer
+ + +

+Interface for Player model +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.awt.ColorgetColor() + +
+          Return the player's color
+ IHandgetHand() + +
+          Get the current hand of the player
+ java.lang.StringgetName() + +
+          Return the name of the player
+  +

+ + + + + + + + +
+Method Detail
+ +

+getHand

+
+IHand getHand()
+
+
Get the current hand of the player +

+

+ +
Returns:
the player's hand
+
+
+
+ +

+getColor

+
+java.awt.Color getColor()
+
+
Return the player's color +

+

+ +
Returns:
the player's color
+
+
+
+ +

+getName

+
+java.lang.String getName()
+
+
Return the name of the player +

+

+ +
Returns:
the player's name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + 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 @@ + + + + + + +IStoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface IStoneTray<E extends Sizeable>

+
+
Type Parameters:
E - Objects held by the IStoneTray
+
+
All Superinterfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>
+
+
+
All Known Subinterfaces:
IHand, ITable
+
+
+
All Known Implementing Classes:
Hand, StoneTray, Table
+
+
+
+
public interface IStoneTray<E extends Sizeable>
extends java.lang.Iterable<Pair<E,Position>>, java.lang.Cloneable
+ + +

+Interface for the StoneTray model +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IStoneTray<E>clone() + +
+          Create a clone of the StoneTray
+ voiddrop(E object, + Position position) + +
+          Adds object to the tray
+ PositiongetPosition(E object) + +
+          Returns the position of an object that is already on the tray
+ intgetSize() + +
+          Return the number of objects on the tray
+ booleanpickUp(E object) + +
+          Tries to pick up (remove) a given object
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Method Detail
+ +

+drop

+
+void drop(E object,
+          Position position)
+
+
Adds object to the tray +

+

+
+
+
+
Parameters:
object - object to add to Hand
position - Position to put the object
+
+
+
+ +

+getPosition

+
+Position getPosition(E object)
+
+
Returns the position of an object that is already on the tray +

+

+
+
+
+
Parameters:
object - object whose position is requested +
Returns:
position of the object or null when the object is not on the tray
+
+
+
+ +

+pickUp

+
+boolean pickUp(E object)
+
+
Tries to pick up (remove) a given object +

+

+
+
+
+
Parameters:
object - object to pick up +
Returns:
true when the object was successfully removed
+
+
+
+ +

+clone

+
+IStoneTray<E> clone()
+
+
Create a clone of the StoneTray +

+

+
+
+
+ +
Returns:
cloned StoneTray
+
+
+
+ +

+getSize

+
+int getSize()
+
+
Return the number of objects on the tray +

+

+
+
+
+ +
Returns:
number of objects
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/ITable.html b/doc/jrummikub/model/ITable.html new file mode 100644 index 0000000..a4d2b89 --- /dev/null +++ b/doc/jrummikub/model/ITable.html @@ -0,0 +1,289 @@ + + + + + + +ITable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface ITable

+
+
All Superinterfaces:
java.lang.Cloneable, IStoneTray<StoneSet>, java.lang.Iterable<Pair<StoneSet,Position>>
+
+
+
All Known Implementing Classes:
Table
+
+
+
+
public interface ITable
extends IStoneTray<StoneSet>
+ + +

+Interface for the Table model +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSetfindStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ booleanisValid() + +
+          Tests the Table for rule conflicts by checking all the StoneSet
+ voidpickUpStone(Stone stone) + +
+          Removes Stone from the Table
+  + + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Method Detail
+ +

+pickUpStone

+
+void pickUpStone(Stone stone)
+
+
Removes Stone from the Table +

+

+
+
+
+
Parameters:
stone - stone to pick up
+
+
+
+ +

+isValid

+
+boolean isValid()
+
+
Tests the Table for rule conflicts by checking all the StoneSet +

+

+
+
+
+ +
Returns:
whether all sets on the table are valid
+
+
+
+ +

+findStoneSet

+
+StoneSet findStoneSet(Stone stone)
+
+
Finds the StoneSet containing the given Stone +

+

+
+
+
+
Parameters:
stone - stone whose set we're searching +
Returns:
the set containing the stone or null if no set was found
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Player.html b/doc/jrummikub/model/Player.html new file mode 100644 index 0000000..9bc12ba --- /dev/null +++ b/doc/jrummikub/model/Player.html @@ -0,0 +1,324 @@ + + + + + + +Player + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class Player

+
+java.lang.Object
+  extended by jrummikub.model.Player
+
+
+
All Implemented Interfaces:
IPlayer
+
+
+
+
public class Player
extends java.lang.Object
implements IPlayer
+ + +

+Class managing player data. No methods in release 1 +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Player(java.lang.String name, + java.awt.Color color) + +
+          Create a new player with a given name and color
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.awt.ColorgetColor() + +
+          Return the player's color
+ IHandgetHand() + +
+          Get the current hand of the player
+ java.lang.StringgetName() + +
+          Return the name of the player
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Player

+
+public Player(java.lang.String name,
+              java.awt.Color color)
+
+
Create a new player with a given name and color +

+

+
Parameters:
name - player name
color - player's color
+
+ + + + + + + + +
+Method Detail
+ +

+getHand

+
+public IHand getHand()
+
+
Description copied from interface: IPlayer
+
Get the current hand of the player +

+

+
Specified by:
getHand in interface IPlayer
+
+
+ +
Returns:
the player's hand
+
+
+
+ +

+getColor

+
+public java.awt.Color getColor()
+
+
Description copied from interface: IPlayer
+
Return the player's color +

+

+
Specified by:
getColor in interface IPlayer
+
+
+ +
Returns:
the player's color
+
+
+
+ +

+getName

+
+public java.lang.String getName()
+
+
Description copied from interface: IPlayer
+
Return the name of the player +

+

+
Specified by:
getName in interface IPlayer
+
+
+ +
Returns:
the player's name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Position.html b/doc/jrummikub/model/Position.html new file mode 100644 index 0000000..ab41483 --- /dev/null +++ b/doc/jrummikub/model/Position.html @@ -0,0 +1,354 @@ + + + + + + +Position + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class Position

+
+java.lang.Object
+  extended by jrummikub.model.Position
+
+
+
+
public class Position
extends java.lang.Object
+ + +

+Stone Position class to determine positions on Table or + Hand +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Position(float x, + float y) + +
+          Create a new position by specifying the coordinates
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object obj) + +
+           
+ floatgetX() + +
+          Get the x coordinate of the position
+ floatgetY() + +
+          Get the y coordinate of the position
+ inthashCode() + +
+           
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Position

+
+public Position(float x,
+                float y)
+
+
Create a new position by specifying the coordinates +

+

+
Parameters:
x - x coordinate
y - y coordinate
+
+ + + + + + + + +
+Method Detail
+ +

+getX

+
+public float getX()
+
+
Get the x coordinate of the position +

+

+ +
Returns:
x coordinate
+
+
+
+ +

+getY

+
+public float getY()
+
+
Get the y coordinate of the position +

+

+ +
Returns:
y coordinate
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object obj)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Sizeable.html b/doc/jrummikub/model/Sizeable.html new file mode 100644 index 0000000..0c6ee5a --- /dev/null +++ b/doc/jrummikub/model/Sizeable.html @@ -0,0 +1,240 @@ + + + + + + +Sizeable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Interface Sizeable

+
+
All Known Implementing Classes:
Stone, StoneSet
+
+
+
+
public interface Sizeable
+ + +

+Objects that have a size. This interface has to be implemented for objects + placed on a @{link StoneTray} to make detection of overlapping objects + possible. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ floatgetHeight() + +
+          Get the height of the object
+ floatgetWidth() + +
+          Get the width of the object
+  +

+ + + + + + + + +
+Method Detail
+ +

+getWidth

+
+float getWidth()
+
+
Get the width of the object +

+

+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+float getHeight()
+
+
Get the height of the object +

+

+ +
Returns:
object height
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Stone.html b/doc/jrummikub/model/Stone.html new file mode 100644 index 0000000..647f08c --- /dev/null +++ b/doc/jrummikub/model/Stone.html @@ -0,0 +1,414 @@ + + + + + + +Stone + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class Stone

+
+java.lang.Object
+  extended by jrummikub.model.Stone
+
+
+
All Implemented Interfaces:
Sizeable
+
+
+
+
public class Stone
extends java.lang.Object
implements Sizeable
+ + +

+Basic Rummikub Stone +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
Stone(int value, + StoneColor color) + +
+          Creates a normal stone of a given color and value
Stone(StoneColor color) + +
+          Creates a joker of the given color.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneColorgetColor() + +
+          Returns the color of the stone.
+ floatgetHeight() + +
+          Get the height of the object
+ intgetValue() + +
+          Returns the value of the stone.
+ floatgetWidth() + +
+          Get the width of the object
+ booleanisJoker() + +
+          Returns whether the stone is a joker or not.
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Stone

+
+public Stone(StoneColor color)
+
+
Creates a joker of the given color. The color is only used for + displaying. +

+

+
Parameters:
color - joker color
+
+
+ +

+Stone

+
+public Stone(int value,
+             StoneColor color)
+
+
Creates a normal stone of a given color and value +

+

+
Parameters:
value - stone value
color - stone color
+
+ + + + + + + + +
+Method Detail
+ +

+getColor

+
+public StoneColor getColor()
+
+
Returns the color of the stone. +

+

+
+
+
+ +
Returns:
stone color
+
+
+
+ +

+isJoker

+
+public boolean isJoker()
+
+
Returns whether the stone is a joker or not. +

+

+
+
+
+ +
Returns:
true when the stone is a joker
+
+
+
+ +

+getValue

+
+public int getValue()
+
+
Returns the value of the stone. Don't use this value for jokers. +

+

+
+
+
+ +
Returns:
stone value
+
+
+
+ +

+getWidth

+
+public float getWidth()
+
+
Description copied from interface: Sizeable
+
Get the width of the object +

+

+
Specified by:
getWidth in interface Sizeable
+
+
+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+public float getHeight()
+
+
Description copied from interface: Sizeable
+
Get the height of the object +

+

+
Specified by:
getHeight in interface Sizeable
+
+
+ +
Returns:
object height
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneColor.html b/doc/jrummikub/model/StoneColor.html new file mode 100644 index 0000000..bd4667a --- /dev/null +++ b/doc/jrummikub/model/StoneColor.html @@ -0,0 +1,358 @@ + + + + + + +StoneColor + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneColor

+
+java.lang.Object
+  extended by java.lang.Enum<StoneColor>
+      extended by jrummikub.model.StoneColor
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneColor>
+
+
+
+
public enum StoneColor
extends java.lang.Enum<StoneColor>
+ + +

+Class specifying possible StoneColors +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BLACK + +
+           
BLUE + +
+           
ORANGE + +
+           
RED + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneColorvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneColor[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+BLACK

+
+public static final StoneColor BLACK
+
+
+
+
+
+ +

+ORANGE

+
+public static final StoneColor ORANGE
+
+
+
+
+
+ +

+BLUE

+
+public static final StoneColor BLUE
+
+
+
+
+
+ +

+RED

+
+public static final StoneColor RED
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneColor[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneColor c : StoneColor.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneColor valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneHeap.html b/doc/jrummikub/model/StoneHeap.html new file mode 100644 index 0000000..d08f77c --- /dev/null +++ b/doc/jrummikub/model/StoneHeap.html @@ -0,0 +1,363 @@ + + + + + + +StoneHeap + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class StoneHeap

+
+java.lang.Object
+  extended by jrummikub.model.StoneHeap
+
+
+
+
public class StoneHeap
extends java.lang.Object
+ + +

+StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones. +

+ +

+

+ +

+ + + + + + + + + + + +
+Field Summary
+(package private)  java.util.List<Stone>heap + +
+           
+  + + + + + + + + + + +
+Constructor Summary
StoneHeap() + +
+          Creates 106 Stones according to standard rules
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StonedrawStone() + +
+          Removes random Stone from the heap and returns it
+ java.util.List<Stone>drawStones(int number) + +
+          Removes several Stones from the heap and returns them
+ intgetSize() + +
+          Get the number of stones left
+ voidputBack(java.util.Collection<Stone> stones) + +
+          Put stones back on the heap
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+heap

+
+java.util.List<Stone> heap
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneHeap

+
+public StoneHeap()
+
+
Creates 106 Stones according to standard rules +

+

+ + + + + + + + +
+Method Detail
+ +

+drawStone

+
+public Stone drawStone()
+
+
Removes random Stone from the heap and returns it +

+

+ +
Returns:
the drawn stone
+
+
+
+ +

+drawStones

+
+public java.util.List<Stone> drawStones(int number)
+
+
Removes several Stones from the heap and returns them +

+

+
Parameters:
number - number of requested Stones +
Returns:
list of drawn stones
+
+
+
+ +

+getSize

+
+public int getSize()
+
+
Get the number of stones left +

+

+ +
Returns:
number of stones on the heap
+
+
+
+ +

+putBack

+
+public void putBack(java.util.Collection<Stone> stones)
+
+
Put stones back on the heap +

+

+
Parameters:
stones - collection of stones to put back
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneSet.Type.html b/doc/jrummikub/model/StoneSet.Type.html new file mode 100644 index 0000000..d349fb7 --- /dev/null +++ b/doc/jrummikub/model/StoneSet.Type.html @@ -0,0 +1,351 @@ + + + + + + +StoneSet.Type + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneSet.Type

+
+java.lang.Object
+  extended by java.lang.Enum<StoneSet.Type>
+      extended by jrummikub.model.StoneSet.Type
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneSet.Type>
+
+
+
Enclosing class:
StoneSet
+
+
+
+
public static enum StoneSet.Type
extends java.lang.Enum<StoneSet.Type>
+ + +

+Validity type of the set +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
GROUP + +
+          Set is a valid group
INVALID + +
+          Set is invalid
RUN + +
+          Set is a valid run
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneSet.TypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneSet.Type[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+GROUP

+
+public static final StoneSet.Type GROUP
+
+
Set is a valid group +

+

+
+
+
+ +

+RUN

+
+public static final StoneSet.Type RUN
+
+
Set is a valid run +

+

+
+
+
+ +

+INVALID

+
+public static final StoneSet.Type INVALID
+
+
Set is invalid +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneSet.Type[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneSet.Type c : StoneSet.Type.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneSet.Type valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneSet.html b/doc/jrummikub/model/StoneSet.html new file mode 100644 index 0000000..5cf6895 --- /dev/null +++ b/doc/jrummikub/model/StoneSet.html @@ -0,0 +1,583 @@ + + + + + + +StoneSet + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class StoneSet

+
+java.lang.Object
+  extended by jrummikub.model.StoneSet
+
+
+
All Implemented Interfaces:
java.lang.Iterable<Stone>, Sizeable
+
+
+
+
public class StoneSet
extends java.lang.Object
implements java.lang.Iterable<Stone>, Sizeable
+ + +

+Class managing Stones joined together to form sets +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classStoneSet.Type + +
+          Validity type of the set
+  + + + + + + + + + + + + + + +
+Field Summary
+(package private) static floatHORIZONTAL_BORDER + +
+           
+(package private) static floatVERTICAL_BORDER + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
StoneSet(java.util.List<Stone> stones) + +
+          Create a stone set from a list of stones
StoneSet(Stone stone) + +
+          Create a new single stone stone set
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSet.Typeclassify() + +
+          Test for rule conflict within the StoneSet and determine whether the set + is a group or a run
+ Stoneget(int i) + +
+          Returns the i-th stone of the set (starting with 0)
+ floatgetHeight() + +
+          Get the height of the object
+ floatgetWidth() + +
+          Get the width of the object
+ booleanisValid() + +
+          Test for rule conflict within the StoneSet
+ java.util.Iterator<Stone>iterator() + +
+           
+ StoneSetjoin(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+ intsize() + +
+          Returns the number of stones in the set.
+ Pair<StoneSet,StoneSet>splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+VERTICAL_BORDER

+
+static final float VERTICAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+
+ +

+HORIZONTAL_BORDER

+
+static final float HORIZONTAL_BORDER
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneSet

+
+public StoneSet(Stone stone)
+
+
Create a new single stone stone set +

+

+
Parameters:
stone - single stone of the set
+
+
+ +

+StoneSet

+
+public StoneSet(java.util.List<Stone> stones)
+
+
Create a stone set from a list of stones +

+

+
Parameters:
stones - list of stones to build a set of
+
+ + + + + + + + +
+Method Detail
+ +

+isValid

+
+public boolean isValid()
+
+
Test for rule conflict within the StoneSet +

+

+
+
+
+ +
Returns:
true when the set is valid according to the rules
+
+
+
+ +

+classify

+
+public StoneSet.Type classify()
+
+
Test for rule conflict within the StoneSet and determine whether the set + is a group or a run +

+

+
+
+
+ +
Returns:
GROUP or RUN for valid sets, INVALID otherwise
+
+
+
+ +

+splitAt

+
+public Pair<StoneSet,StoneSet> splitAt(int position)
+
+
Splits the StoneSet at a specified Position and returns two new + Stone Sets +

+

+
+
+
+
Parameters:
position - Splitting Position +
Returns:
A pair of StoneSets, one for each split part
+
+
+
+ +

+join

+
+public StoneSet join(StoneSet other)
+
+
Joins StoneSet to another StoneSet and returns the resulting new StoneSet +

+

+
+
+
+
Parameters:
other - StoneSet to be joined to active StoneSet +
Returns:
the combined StoneSet
+
+
+
+ +

+size

+
+public int size()
+
+
Returns the number of stones in the set. +

+

+
+
+
+ +
Returns:
number of stones
+
+
+
+ +

+get

+
+public Stone get(int i)
+
+
Returns the i-th stone of the set (starting with 0) +

+

+
+
+
+
Parameters:
i - number of the stone to return +
Returns:
the i-th stone
+
+
+
+ +

+iterator

+
+public java.util.Iterator<Stone> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<Stone>
+
+
+
+
+
+
+ +

+getWidth

+
+public float getWidth()
+
+
Description copied from interface: Sizeable
+
Get the width of the object +

+

+
Specified by:
getWidth in interface Sizeable
+
+
+ +
Returns:
object width
+
+
+
+ +

+getHeight

+
+public float getHeight()
+
+
Description copied from interface: Sizeable
+
Get the height of the object +

+

+
Specified by:
getHeight in interface Sizeable
+
+
+ +
Returns:
object height
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneTray.Direction.html b/doc/jrummikub/model/StoneTray.Direction.html new file mode 100644 index 0000000..49c60bc --- /dev/null +++ b/doc/jrummikub/model/StoneTray.Direction.html @@ -0,0 +1,361 @@ + + + + + + +StoneTray.Direction + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Enum StoneTray.Direction

+
+java.lang.Object
+  extended by java.lang.Enum<StoneTray.Direction>
+      extended by jrummikub.model.StoneTray.Direction
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StoneTray.Direction>
+
+
+
Enclosing class:
StoneTray<E extends Sizeable>
+
+
+
+
protected static enum StoneTray.Direction
extends java.lang.Enum<StoneTray.Direction>
+ + +

+Possible move directions in case of overlapping Stones/Sets +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BOTTOM + +
+           
LEFT + +
+           
RIGHT + +
+           
TOP + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StoneTray.DirectionvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneTray.Direction[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+LEFT

+
+public static final StoneTray.Direction LEFT
+
+
+
+
+
+ +

+RIGHT

+
+public static final StoneTray.Direction RIGHT
+
+
+
+
+
+ +

+TOP

+
+public static final StoneTray.Direction TOP
+
+
+
+
+
+ +

+BOTTOM

+
+public static final StoneTray.Direction BOTTOM
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static StoneTray.Direction[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (StoneTray.Direction c : StoneTray.Direction.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static StoneTray.Direction valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/StoneTray.html b/doc/jrummikub/model/StoneTray.html new file mode 100644 index 0000000..a980742 --- /dev/null +++ b/doc/jrummikub/model/StoneTray.html @@ -0,0 +1,483 @@ + + + + + + +StoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class StoneTray<E extends Sizeable>

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<E>
+
+
+
Type Parameters:
E - Type of positioned objects (must implement Sizeable)
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<E,Position>>, IStoneTray<E>
+
+
+
Direct Known Subclasses:
Hand, Table
+
+
+
+
public class StoneTray<E extends Sizeable>
extends java.lang.Object
implements IStoneTray<E>
+ + +

+A StoneTray is a collection of positioned objects (for example Stones + or StoneSets. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+protected static classStoneTray.Direction + +
+          Possible move directions in case of overlapping Stones/Sets
+  + + + + + + + + + + +
+Field Summary
+protected  java.util.HashMap<E,Pair<E,Position>>objects + +
+           
+  + + + + + + + + + + +
+Constructor Summary
StoneTray() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IStoneTray<E>clone() + +
+          Create a clone of the StoneTray
+ voiddrop(E object, + Position position) + +
+          Adds object to the tray
+protected  Pair<Position,StoneTray.Direction>fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+ PositiongetPosition(E object) + +
+          Returns the position of an object that is already on the tray
+ intgetSize() + +
+          Return the number of objects on the tray
+ java.util.Iterator<Pair<E,Position>>iterator() + +
+           
+ booleanpickUp(E object) + +
+          Tries to pick up (remove) a given object
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+objects

+
+protected java.util.HashMap<E extends Sizeable,Pair<E extends Sizeable,Position>> objects
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+StoneTray

+
+public StoneTray()
+
+
+ + + + + + + + +
+Method Detail
+ +

+drop

+
+public void drop(E object,
+                 Position position)
+
+
Description copied from interface: IStoneTray
+
Adds object to the tray +

+

+
Specified by:
drop in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object to add to Hand
position - Position to put the object
+
+
+
+ +

+fixInvalidDrop

+
+protected Pair<Position,StoneTray.Direction> fixInvalidDrop(E object,
+                                                            Position pos,
+                                                            StoneTray.Direction dir)
+
+
Checks whether the object may be placed on the given position, computes + new position if not +

+

+
+
+
+
Parameters:
object - to be dropped
dir -
pos - the object is dropped at +
Returns:
null if the drop is valid, new position otherwise
+
+
+
+ +

+getPosition

+
+public Position getPosition(E object)
+
+
Description copied from interface: IStoneTray
+
Returns the position of an object that is already on the tray +

+

+
Specified by:
getPosition in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object whose position is requested +
Returns:
position of the object or null when the object is not on the tray
+
+
+
+ +

+iterator

+
+public java.util.Iterator<Pair<E,Position>> iterator()
+
+
+
Specified by:
iterator in interface java.lang.Iterable<Pair<E extends Sizeable,Position>>
+
+
+
+
+
+
+ +

+pickUp

+
+public boolean pickUp(E object)
+
+
Description copied from interface: IStoneTray
+
Tries to pick up (remove) a given object +

+

+
Specified by:
pickUp in interface IStoneTray<E extends Sizeable>
+
+
+
Parameters:
object - object to pick up +
Returns:
true when the object was successfully removed
+
+
+
+ +

+clone

+
+public IStoneTray<E> clone()
+
+
Description copied from interface: IStoneTray
+
Create a clone of the StoneTray +

+

+
Specified by:
clone in interface IStoneTray<E extends Sizeable>
Overrides:
clone in class java.lang.Object
+
+
+ +
Returns:
cloned StoneTray
+
+
+
+ +

+getSize

+
+public int getSize()
+
+
Description copied from interface: IStoneTray
+
Return the number of objects on the tray +

+

+
Specified by:
getSize in interface IStoneTray<E extends Sizeable>
+
+
+ +
Returns:
number of objects
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/Table.html b/doc/jrummikub/model/Table.html new file mode 100644 index 0000000..721ef67 --- /dev/null +++ b/doc/jrummikub/model/Table.html @@ -0,0 +1,380 @@ + + + + + + +Table + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +jrummikub.model +
+Class Table

+
+java.lang.Object
+  extended by jrummikub.model.StoneTray<StoneSet>
+      extended by jrummikub.model.Table
+
+
+
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<Pair<StoneSet,Position>>, IStoneTray<StoneSet>, ITable
+
+
+
+
public class Table
extends StoneTray<StoneSet>
implements ITable
+ + +

+Class administering the Stones on the game-Table +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class jrummikub.model.StoneTray
StoneTray.Direction
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class jrummikub.model.StoneTray
objects
+  + + + + + + + + + + +
+Constructor Summary
Table() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StoneSetfindStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ booleanisValid() + +
+          Tests the Table for rule conflicts by checking all the StoneSet
+ voidpickUpStone(Stone stone) + +
+          Removes Stone from the Table
+  + + + + + + + +
Methods inherited from class jrummikub.model.StoneTray
clone, drop, fixInvalidDrop, getPosition, getSize, iterator, pickUp
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface jrummikub.model.IStoneTray
clone, drop, getPosition, getSize, pickUp
+  + + + + + + + +
Methods inherited from interface java.lang.Iterable
iterator
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Table

+
+public Table()
+
+
+ + + + + + + + +
+Method Detail
+ +

+pickUpStone

+
+public void pickUpStone(Stone stone)
+
+
Removes Stone from the Table +

+

+
Specified by:
pickUpStone in interface ITable
+
+
+
Parameters:
stone - stone to pick up
+
+
+
+ +

+findStoneSet

+
+public StoneSet findStoneSet(Stone stone)
+
+
Description copied from interface: ITable
+
Finds the StoneSet containing the given Stone +

+

+
Specified by:
findStoneSet in interface ITable
+
+
+
Parameters:
stone - stone whose set we're searching +
Returns:
the set containing the stone or null if no set was found
+
+
+
+ +

+isValid

+
+public boolean isValid()
+
+
Tests the Table for rule conflicts by checking all the StoneSet +

+

+
Specified by:
isValid in interface ITable
+
+
+ +
Returns:
whether all sets on the table are valid
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/GameState.html b/doc/jrummikub/model/class-use/GameState.html new file mode 100644 index 0000000..ae05b77 --- /dev/null +++ b/doc/jrummikub/model/class-use/GameState.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.GameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.GameState

+
+No usage of jrummikub.model.GameState +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Hand.html b/doc/jrummikub/model/class-use/Hand.html new file mode 100644 index 0000000..4100345 --- /dev/null +++ b/doc/jrummikub/model/class-use/Hand.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Hand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.Hand

+
+No usage of jrummikub.model.Hand +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IGameState.html b/doc/jrummikub/model/class-use/IGameState.html new file mode 100644 index 0000000..2912a4d --- /dev/null +++ b/doc/jrummikub/model/class-use/IGameState.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Interface jrummikub.model.IGameState + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IGameState

+
+ + + + + + + + + + + + + +
+Packages that use IGameState
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of IGameState in jrummikub.control
+  +

+ + + + + + + + +
Constructors in jrummikub.control with parameters of type IGameState
RoundControl(IGameState gameState, + IView view) + +
+          Create a new RoundControl using the given gameState and view
+  +

+ + + + + +
+Uses of IGameState in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IGameState
+ classGameState + +
+          Class managing the overall and momentary GameState
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IHand.html b/doc/jrummikub/model/class-use/IHand.html new file mode 100644 index 0000000..5f3a4a4 --- /dev/null +++ b/doc/jrummikub/model/class-use/IHand.html @@ -0,0 +1,243 @@ + + + + + + +Uses of Interface jrummikub.model.IHand + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IHand

+
+ + + + + + + + + + + + + +
+Packages that use IHand
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of IHand in jrummikub.control
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.control with parameters of type IHand
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+ + + + + +
+Uses of IHand in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IHand
+ classHand + +
+          Class managing a Player's Stones
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return IHand
+ IHandPlayer.getHand() + +
+           
+ IHandIPlayer.getHand() + +
+          Get the current hand of the player
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IPlayer.html b/doc/jrummikub/model/class-use/IPlayer.html new file mode 100644 index 0000000..8c8bad6 --- /dev/null +++ b/doc/jrummikub/model/class-use/IPlayer.html @@ -0,0 +1,220 @@ + + + + + + +Uses of Interface jrummikub.model.IPlayer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IPlayer

+
+ + + + + + + + + +
+Packages that use IPlayer
jrummikub.model  
+  +

+ + + + + +
+Uses of IPlayer in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement IPlayer
+ classPlayer + +
+          Class managing player data.
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return IPlayer
+ IPlayerGameState.getActivePlayer() + +
+           
+ IPlayerIGameState.getActivePlayer() + +
+          Returns the currently active player
+ IPlayerGameState.getNthNextPlayer(int i) + +
+           
+ IPlayerIGameState.getNthNextPlayer(int i) + +
+          Returns the player that would be the active player after i turns
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/IStoneTray.html b/doc/jrummikub/model/class-use/IStoneTray.html new file mode 100644 index 0000000..44ec421 --- /dev/null +++ b/doc/jrummikub/model/class-use/IStoneTray.html @@ -0,0 +1,245 @@ + + + + + + +Uses of Interface jrummikub.model.IStoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.IStoneTray

+
+ + + + + + + + + +
+Packages that use IStoneTray
jrummikub.model  
+  +

+ + + + + +
+Uses of IStoneTray in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Subinterfaces of IStoneTray in jrummikub.model
+ interfaceIHand + +
+          Interface for the Hand model
+ interfaceITable + +
+          Interface for the Table model
+  +

+ + + + + + + + + + + + + + + + + +
Classes in jrummikub.model that implement IStoneTray
+ classHand + +
+          Class managing a Player's Stones
+ classStoneTray<E extends Sizeable> + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return IStoneTray
+ IStoneTray<E>StoneTray.clone() + +
+           
+ IStoneTray<E>IStoneTray.clone() + +
+          Create a clone of the StoneTray
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/ITable.html b/doc/jrummikub/model/class-use/ITable.html new file mode 100644 index 0000000..389391a --- /dev/null +++ b/doc/jrummikub/model/class-use/ITable.html @@ -0,0 +1,284 @@ + + + + + + +Uses of Interface jrummikub.model.ITable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.ITable

+
+ + + + + + + + + + + + + +
+Packages that use ITable
jrummikub.control  
jrummikub.model  
+  +

+ + + + + +
+Uses of ITable in jrummikub.control
+  +

+ + + + + + + + + +
Methods in jrummikub.control with parameters of type ITable
+(package private) static java.util.Set<Stone>RoundControl.tableDifference(ITable oldTable, + ITable newTable) + +
+           
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.control with parameters of type ITable
TurnControl(IHand hand, + ITable table, + IView view) + +
+          Create a new TurnControl using a given hand (of the active player), a given + table and a given view for user interaction.
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+ + + + + +
+Uses of ITable in jrummikub.model
+  +

+ + + + + + + + + +
Classes in jrummikub.model that implement ITable
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return ITable
+ ITableGameState.getTable() + +
+           
+ ITableIGameState.getTable() + +
+          Get the current Table
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type ITable
+ voidGameState.setTable(ITable table) + +
+           
+ voidIGameState.setTable(ITable table) + +
+          Sets the current Table
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Player.html b/doc/jrummikub/model/class-use/Player.html new file mode 100644 index 0000000..ca51d52 --- /dev/null +++ b/doc/jrummikub/model/class-use/Player.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Player + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.Player

+
+No usage of jrummikub.model.Player +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Position.html b/doc/jrummikub/model/class-use/Position.html new file mode 100644 index 0000000..02e14f5 --- /dev/null +++ b/doc/jrummikub/model/class-use/Position.html @@ -0,0 +1,526 @@ + + + + + + +Uses of Class jrummikub.model.Position + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.Position

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Position
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Position in jrummikub.control
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.control with type arguments of type Position
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+  +

+ + + + + +
+Uses of Position in jrummikub.model
+  +

+ + + + + + + + + +
Fields in jrummikub.model with type parameters of type Position
+protected  java.util.HashMap<E,Pair<E,Position>>StoneTray.objects + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return Position
+ PositionStoneTray.getPosition(E object) + +
+           
+ PositionIStoneTray.getPosition(E object) + +
+          Returns the position of an object that is already on the tray
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type Position
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+ java.util.Iterator<Pair<E,Position>>StoneTray.iterator() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type Position
+ voidStoneTray.drop(E object, + Position position) + +
+           
+ voidIStoneTray.drop(E object, + Position position) + +
+          Adds object to the tray
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+ + + + + +
+Uses of Position in jrummikub.view
+  +

+ + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type Position
+ IEvent1<Position>IClickable.getClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type Position
+ voidIHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+ voidITablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+  +

+ + + + + +
+Uses of Position in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return Position
+ PositionStonePainter.calculatePosition(int x, + int y) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type Position
+ Event1<Position>AbstractStonePanel.getClickEvent() + +
+           
+protected  java.lang.Iterable<Pair<Stone,Position>>AbstractStonePanel.getStones() + +
+          Returns the list of stones and positions currently set
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl with parameters of type Position
+protected  booleanStoneCollectionPanel.handleOtherClickEvent(Position pos) + +
+           
+protected  booleanTablePanel.handleOtherClickEvent(Position pos) + +
+           
+protected  booleanAbstractStonePanel.handleOtherClickEvent(Position pos) + +
+          Overwrite this method to signal if special zone was clicked
+protected  voidTablePanel.handleOtherMoveEvent(Position pos) + +
+           
+protected  voidAbstractStonePanel.handleOtherMoveEvent(Position pos) + +
+          Overwrite this method to signal if special zone was hovered
+ voidStonePainter.paintStone(java.awt.Graphics2D g, + Stone stone, + Position p, + boolean selected, + boolean hovered) + +
+          Paints a stone
+  +

+ + + + + + + + + + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type Position
+ voidHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+           
+protected  voidAbstractStonePanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+ voidTablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Sizeable.html b/doc/jrummikub/model/class-use/Sizeable.html new file mode 100644 index 0000000..d618618 --- /dev/null +++ b/doc/jrummikub/model/class-use/Sizeable.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Interface jrummikub.model.Sizeable + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
jrummikub.model.Sizeable

+
+ + + + + + + + + +
+Packages that use Sizeable
jrummikub.model  
+  +

+ + + + + +
+Uses of Sizeable in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Classes in jrummikub.model with type parameters of type Sizeable
+ interfaceIStoneTray<E extends Sizeable> + +
+          Interface for the StoneTray model
+ classStoneTray<E extends Sizeable> + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
+  +

+ + + + + + + + + + + + + +
Classes in jrummikub.model that implement Sizeable
+ classStone + +
+          Basic Rummikub Stone
+ classStoneSet + +
+          Class managing Stones joined together to form sets
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Stone.html b/doc/jrummikub/model/class-use/Stone.html new file mode 100644 index 0000000..4f4ffb2 --- /dev/null +++ b/doc/jrummikub/model/class-use/Stone.html @@ -0,0 +1,594 @@ + + + + + + +Uses of Class jrummikub.model.Stone + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.Stone

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use Stone
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of Stone in jrummikub.control
+  +

+ + + + + + + + + +
Methods in jrummikub.control that return types with arguments of type Stone
+(package private) static java.util.Set<Stone>RoundControl.tableDifference(ITable oldTable, + ITable newTable) + +
+           
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.control with type arguments of type Stone
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ intTurnControl.HandStonePositionComparator.compare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+  +

+ + + + + +
+Uses of Stone in jrummikub.model
+  +

+ + + + + + + + + +
Fields in jrummikub.model with type parameters of type Stone
+(package private)  java.util.List<Stone>StoneHeap.heap + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return Stone
+ StoneStoneHeap.drawStone() + +
+          Removes random Stone from the heap and returns it
+ StoneStoneSet.get(int i) + +
+          Returns the i-th stone of the set (starting with 0)
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type Stone
+ java.util.List<Stone>StoneHeap.drawStones(int number) + +
+          Removes several Stones from the heap and returns them
+ java.util.Iterator<Stone>StoneSet.iterator() + +
+           
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type Stone
+ StoneSetTable.findStoneSet(Stone stone) + +
+           
+ StoneSetITable.findStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+ voidTable.pickUpStone(Stone stone) + +
+          Removes Stone from the Table
+ voidITable.pickUpStone(Stone stone) + +
+          Removes Stone from the Table
+  +

+ + + + + + + + + +
Method parameters in jrummikub.model with type arguments of type Stone
+ voidStoneHeap.putBack(java.util.Collection<Stone> stones) + +
+          Put stones back on the heap
+  +

+ + + + + + + + +
Constructors in jrummikub.model with parameters of type Stone
StoneSet(Stone stone) + +
+          Create a new single stone stone set
+  +

+ + + + + + + + +
Constructor parameters in jrummikub.model with type arguments of type Stone
StoneSet(java.util.List<Stone> stones) + +
+          Create a stone set from a list of stones
+  +

+ + + + + +
+Uses of Stone in jrummikub.view
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type Stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getRangeClickEvent() + +
+          the range click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a range instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getSetClickEvent() + +
+          the set click event is emitted when the player clicks on the table/hand/ + etc. and wants to select a whole set instead of a single stone
+ IEvent2<Stone,java.lang.Boolean>IStonePanel.getStoneClickEvent() + +
+          the click event is emitted when the player clicks on the table/hand/etc.
+  +

+ + + + + + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type Stone
+ voidIView.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+ voidIHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Set the player's stones to display on the board
+  +

+ + + + + +
+Uses of Stone in jrummikub.view.impl
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl that return Stone
+protected  StoneAbstractStonePanel.getHoveredStone() + +
+          Returns the stone the mouse pointer is hovering over
+  +

+ + + + + + + + + + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type Stone
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getRangeClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getSetClickEvent() + +
+           
+ Event2<Stone,java.lang.Boolean>AbstractStonePanel.getStoneClickEvent() + +
+           
+protected  java.lang.Iterable<Pair<Stone,Position>>AbstractStonePanel.getStones() + +
+          Returns the list of stones and positions currently set
+  +

+ + + + + + + + + +
Methods in jrummikub.view.impl with parameters of type Stone
+ voidStonePainter.paintStone(java.awt.Graphics2D g, + Stone stone, + Position p, + boolean selected, + boolean hovered) + +
+          Paints a stone
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type Stone
+ voidView.setSelectedStones(java.util.Collection<Stone> stones) + +
+           
+(package private)  voidHandPanel.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the stones that are to be painted selected
+(package private)  voidStoneCollectionPanel.setSelectedStones(java.util.Collection<Stone> selectedStones) + +
+          Sets the stones to be shown in the collection
+(package private)  voidTablePanel.setSelectedStones(java.util.Collection<Stone> stones) + +
+          Sets the currently selected stones
+ voidHandPanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+           
+protected  voidAbstractStonePanel.setStones(java.lang.Iterable<Pair<Stone,Position>> stones) + +
+          Sets the list of stones that can be clicked on
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneColor.html b/doc/jrummikub/model/class-use/StoneColor.html new file mode 100644 index 0000000..607384d --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneColor.html @@ -0,0 +1,218 @@ + + + + + + +Uses of Class jrummikub.model.StoneColor + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneColor

+
+ + + + + + + + + +
+Packages that use StoneColor
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneColor in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneColor
+ StoneColorStone.getColor() + +
+          Returns the color of the stone.
+static StoneColorStoneColor.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneColor[]StoneColor.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + +
Constructors in jrummikub.model with parameters of type StoneColor
Stone(int value, + StoneColor color) + +
+          Creates a normal stone of a given color and value
Stone(StoneColor color) + +
+          Creates a joker of the given color.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneHeap.html b/doc/jrummikub/model/class-use/StoneHeap.html new file mode 100644 index 0000000..444c48e --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneHeap.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class jrummikub.model.StoneHeap + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneHeap

+
+ + + + + + + + + +
+Packages that use StoneHeap
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneHeap in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneHeap
+ StoneHeapGameState.getGameHeap() + +
+           
+ StoneHeapIGameState.getGameHeap() + +
+          Returns the heap of stones to draw from
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneSet.Type.html b/doc/jrummikub/model/class-use/StoneSet.Type.html new file mode 100644 index 0000000..db9e788 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneSet.Type.html @@ -0,0 +1,198 @@ + + + + + + +Uses of Class jrummikub.model.StoneSet.Type + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneSet.Type

+
+ + + + + + + + + +
+Packages that use StoneSet.Type
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneSet.Type in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneSet.Type
+ StoneSet.TypeStoneSet.classify() + +
+          Test for rule conflict within the StoneSet and determine whether the set + is a group or a run
+static StoneSet.TypeStoneSet.Type.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneSet.Type[]StoneSet.Type.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneSet.html b/doc/jrummikub/model/class-use/StoneSet.html new file mode 100644 index 0000000..aa76b18 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneSet.html @@ -0,0 +1,346 @@ + + + + + + +Uses of Class jrummikub.model.StoneSet + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneSet

+
+ + + + + + + + + + + + + + + + + +
+Packages that use StoneSet
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.model
+  +

+ + + + + + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneSet
+ StoneSetTable.findStoneSet(Stone stone) + +
+           
+ StoneSetITable.findStoneSet(Stone stone) + +
+          Finds the StoneSet containing the given Stone
+ StoneSetStoneSet.join(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type StoneSet
+ Pair<StoneSet,StoneSet>StoneSet.splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+ Pair<StoneSet,StoneSet>StoneSet.splitAt(int position) + +
+          Splits the StoneSet at a specified Position and returns two new + Stone Sets
+  +

+ + + + + + + + + +
Methods in jrummikub.model with parameters of type StoneSet
+ StoneSetStoneSet.join(StoneSet other) + +
+          Joins StoneSet to another StoneSet and returns the resulting new StoneSet
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.view
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view that return types with arguments of type StoneSet
+ Event1<StoneSet>ITablePanel.getLeftConnectorClickEvent() + +
+          the left connector click event is emitted when the player clicks on a left + connector of a stone set on the table .
+ Event1<StoneSet>ITablePanel.getRightConnectorClickEvent() + +
+          the right connector click event is emitted when the player clicks on a + right connector of a stone set on the table .
+  +

+ + + + + + + + + +
Method parameters in jrummikub.view with type arguments of type StoneSet
+ voidITablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+          Sets the stone sets lying on the table
+  +

+ + + + + +
+Uses of StoneSet in jrummikub.view.impl
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.view.impl that return types with arguments of type StoneSet
+ Event1<StoneSet>TablePanel.getLeftConnectorClickEvent() + +
+           
+ Event1<StoneSet>TablePanel.getRightConnectorClickEvent() + +
+           
+  +

+ + + + + + + + + +
Method parameters in jrummikub.view.impl with type arguments of type StoneSet
+ voidTablePanel.setStoneSets(java.lang.Iterable<Pair<StoneSet,Position>> stoneSets) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneTray.Direction.html b/doc/jrummikub/model/class-use/StoneTray.Direction.html new file mode 100644 index 0000000..99dba01 --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneTray.Direction.html @@ -0,0 +1,247 @@ + + + + + + +Uses of Class jrummikub.model.StoneTray.Direction + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneTray.Direction

+
+ + + + + + + + + +
+Packages that use StoneTray.Direction
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneTray.Direction in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return StoneTray.Direction
+static StoneTray.DirectionStoneTray.Direction.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static StoneTray.Direction[]StoneTray.Direction.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model that return types with arguments of type StoneTray.Direction
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+ + + + + + + + + + + + + +
Methods in jrummikub.model with parameters of type StoneTray.Direction
+protected  Pair<Position,StoneTray.Direction>StoneTray.fixInvalidDrop(E object, + Position pos, + StoneTray.Direction dir) + +
+          Checks whether the object may be placed on the given position, computes + new position if not
+protected  Pair<Position,StoneTray.Direction>Hand.fixInvalidDrop(Stone stone, + Position pos, + StoneTray.Direction dir) + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/StoneTray.html b/doc/jrummikub/model/class-use/StoneTray.html new file mode 100644 index 0000000..151751d --- /dev/null +++ b/doc/jrummikub/model/class-use/StoneTray.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class jrummikub.model.StoneTray + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.StoneTray

+
+ + + + + + + + + +
+Packages that use StoneTray
jrummikub.model  
+  +

+ + + + + +
+Uses of StoneTray in jrummikub.model
+  +

+ + + + + + + + + + + + + +
Subclasses of StoneTray in jrummikub.model
+ classHand + +
+          Class managing a Player's Stones
+ classTable + +
+          Class administering the Stones on the game-Table
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/class-use/Table.html b/doc/jrummikub/model/class-use/Table.html new file mode 100644 index 0000000..a609b30 --- /dev/null +++ b/doc/jrummikub/model/class-use/Table.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.model.Table + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
jrummikub.model.Table

+
+No usage of jrummikub.model.Table +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-frame.html b/doc/jrummikub/model/package-frame.html new file mode 100644 index 0000000..2a14a75 --- /dev/null +++ b/doc/jrummikub/model/package-frame.html @@ -0,0 +1,84 @@ + + + + + + +jrummikub.model + + + + + + + + + + + +jrummikub.model + + + + +
+Interfaces  + +
+IGameState +
+IHand +
+IPlayer +
+IStoneTray +
+ITable +
+Sizeable
+ + + + + + +
+Classes  + +
+GameState +
+Hand +
+Player +
+Position +
+Stone +
+StoneHeap +
+StoneSet +
+StoneTray +
+Table
+ + + + + + +
+Enums  + +
+StoneColor +
+StoneSet.Type +
+StoneTray.Direction
+ + + + diff --git a/doc/jrummikub/model/package-summary.html b/doc/jrummikub/model/package-summary.html new file mode 100644 index 0000000..808ee51 --- /dev/null +++ b/doc/jrummikub/model/package-summary.html @@ -0,0 +1,248 @@ + + + + + + +jrummikub.model + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package jrummikub.model +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Interface Summary
IGameStateInterface for GameState model
IHandInterface for the Hand model
IPlayerInterface for Player model
IStoneTray<E extends Sizeable>Interface for the StoneTray model
ITableInterface for the Table model
SizeableObjects that have a size.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameStateClass managing the overall and momentary GameState
HandClass managing a Player's Stones
PlayerClass managing player data.
PositionStone Position class to determine positions on Table or + Hand
StoneBasic Rummikub Stone
StoneHeapStoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones.
StoneSetClass managing Stones joined together to form sets
StoneTray<E extends Sizeable>A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
TableClass administering the Stones on the game-Table
+  + +

+ + + + + + + + + + + + + + + + + +
+Enum Summary
StoneColorClass specifying possible StoneColors
StoneSet.TypeValidity type of the set
StoneTray.DirectionPossible move directions in case of overlapping Stones/Sets
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-tree.html b/doc/jrummikub/model/package-tree.html new file mode 100644 index 0000000..5c93b2e --- /dev/null +++ b/doc/jrummikub/model/package-tree.html @@ -0,0 +1,187 @@ + + + + + + +jrummikub.model Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package jrummikub.model +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/jrummikub/model/package-use.html b/doc/jrummikub/model/package-use.html new file mode 100644 index 0000000..faa02f2 --- /dev/null +++ b/doc/jrummikub/model/package-use.html @@ -0,0 +1,359 @@ + + + + + + +Uses of Package jrummikub.model + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
jrummikub.model

+
+ + + + + + + + + + + + + + + + + + + + + +
+Packages that use jrummikub.model
jrummikub.control  
jrummikub.model  
jrummikub.view  
jrummikub.view.impl  
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.control
IGameState + +
+          Interface for GameState model
IHand + +
+          Interface for the Hand model
ITable + +
+          Interface for the Table model
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.model
IGameState + +
+          Interface for GameState model
IHand + +
+          Interface for the Hand model
IPlayer + +
+          Interface for Player model
IStoneTray + +
+          Interface for the StoneTray model
ITable + +
+          Interface for the Table model
Position + +
+          Stone Position class to determine positions on Table or + Hand
Sizeable + +
+          Objects that have a size.
Stone + +
+          Basic Rummikub Stone
StoneColor + +
+          Class specifying possible StoneColors
StoneHeap + +
+          StoneHeap creates all Stones for a game, manages them and allows + players to draw one or more random Stones.
StoneSet + +
+          Class managing Stones joined together to form sets
StoneSet.Type + +
+          Validity type of the set
StoneTray + +
+          A StoneTray is a collection of positioned objects (for example Stones + or StoneSets.
StoneTray.Direction + +
+          Possible move directions in case of overlapping Stones/Sets
+  +

+ + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.view
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
StoneSet + +
+          Class managing Stones joined together to form sets
+  +

+ + + + + + + + + + + + + + +
+Classes in jrummikub.model used by jrummikub.view.impl
Position + +
+          Stone Position class to determine positions on Table or + Hand
Stone + +
+          Basic Rummikub Stone
StoneSet + +
+          Class managing Stones joined together to form sets
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + -- cgit v1.2.3