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/control/GameControl.html | 262 ++++++++++++++++ doc/jrummikub/control/ITurnTimer.html | 258 +++++++++++++++ doc/jrummikub/control/RoundControl.html | 345 +++++++++++++++++++++ .../TurnControl.HandStonePositionComparator.html | 272 ++++++++++++++++ doc/jrummikub/control/TurnControl.html | 329 ++++++++++++++++++++ doc/jrummikub/control/TurnTimer.html | 342 ++++++++++++++++++++ doc/jrummikub/control/class-use/GameControl.html | 144 +++++++++ doc/jrummikub/control/class-use/ITurnTimer.html | 197 ++++++++++++ doc/jrummikub/control/class-use/RoundControl.html | 144 +++++++++ .../TurnControl.HandStonePositionComparator.html | 144 +++++++++ doc/jrummikub/control/class-use/TurnControl.html | 144 +++++++++ doc/jrummikub/control/class-use/TurnTimer.html | 144 +++++++++ doc/jrummikub/control/package-frame.html | 51 +++ doc/jrummikub/control/package-summary.html | 187 +++++++++++ doc/jrummikub/control/package-tree.html | 160 ++++++++++ doc/jrummikub/control/package-use.html | 170 ++++++++++ 16 files changed, 3293 insertions(+) create mode 100644 doc/jrummikub/control/GameControl.html create mode 100644 doc/jrummikub/control/ITurnTimer.html create mode 100644 doc/jrummikub/control/RoundControl.html create mode 100644 doc/jrummikub/control/TurnControl.HandStonePositionComparator.html create mode 100644 doc/jrummikub/control/TurnControl.html create mode 100644 doc/jrummikub/control/TurnTimer.html create mode 100644 doc/jrummikub/control/class-use/GameControl.html create mode 100644 doc/jrummikub/control/class-use/ITurnTimer.html create mode 100644 doc/jrummikub/control/class-use/RoundControl.html create mode 100644 doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html create mode 100644 doc/jrummikub/control/class-use/TurnControl.html create mode 100644 doc/jrummikub/control/class-use/TurnTimer.html create mode 100644 doc/jrummikub/control/package-frame.html create mode 100644 doc/jrummikub/control/package-summary.html create mode 100644 doc/jrummikub/control/package-tree.html create mode 100644 doc/jrummikub/control/package-use.html (limited to 'doc/jrummikub/control') diff --git a/doc/jrummikub/control/GameControl.html b/doc/jrummikub/control/GameControl.html new file mode 100644 index 0000000..31d6456 --- /dev/null +++ b/doc/jrummikub/control/GameControl.html @@ -0,0 +1,262 @@ + + + + + + +GameControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class GameControl

+
+java.lang.Object
+  extended by jrummikub.control.GameControl
+
+
+
+
public class GameControl
extends java.lang.Object
+ + +

+Controls a Game, at some point including all Rounds, starts new Rounds +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
GameControl(IView view) + +
+          Constructor
+  + + + + + + + + + + + +
+Method Summary
+ voidstartGame() + +
+          Game gets started by initializing the first Round
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+GameControl

+
+public GameControl(IView view)
+
+
Constructor +

+

+
Parameters:
view - the view
+
+ + + + + + + + +
+Method Detail
+ +

+startGame

+
+public void startGame()
+
+
Game gets started by initializing the first Round +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/ITurnTimer.html b/doc/jrummikub/control/ITurnTimer.html new file mode 100644 index 0000000..18671ae --- /dev/null +++ b/doc/jrummikub/control/ITurnTimer.html @@ -0,0 +1,258 @@ + + + + + + +ITurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Interface ITurnTimer

+
+
All Known Implementing Classes:
TurnTimer
+
+
+
+
public interface ITurnTimer
+ + +

+Interface for the TurnTimer +

+ +

+


+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetTimeRunOutEvent() + +
+          Returns the event that is emitted if the timer timed out.
+ voidstartTimer() + +
+          Starts the timer
+ voidstopTimer() + +
+          Stops the timer.
+  +

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

+startTimer

+
+void startTimer()
+
+
Starts the timer +

+

+
+
+
+
+ +

+stopTimer

+
+void stopTimer()
+
+
Stops the timer. Stopping an already stopped timer is a no-op. +

+

+
+
+
+
+ +

+getTimeRunOutEvent

+
+IEvent getTimeRunOutEvent()
+
+
Returns the event that is emitted if the timer timed out. +

+

+ +
Returns:
time out event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/RoundControl.html b/doc/jrummikub/control/RoundControl.html new file mode 100644 index 0000000..e4df927 --- /dev/null +++ b/doc/jrummikub/control/RoundControl.html @@ -0,0 +1,345 @@ + + + + + + +RoundControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class RoundControl

+
+java.lang.Object
+  extended by jrummikub.control.RoundControl
+
+
+
+
public class RoundControl
extends java.lang.Object
+ + +

+Controller that manages a single round of rummikub +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
RoundControl(IGameState gameState, + IView view) + +
+          Create a new RoundControl using the given gameState and view
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+(package private)  voiddeal() + +
+           
+(package private)  voiddealStone() + +
+           
+ IEventgetEndRoundEvent() + +
+          End the round
+ voidstartRound() + +
+          Begin the round
+(package private) static java.util.Set<Stone>tableDifference(ITable oldTable, + ITable newTable) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+RoundControl

+
+public RoundControl(IGameState gameState,
+                    IView view)
+
+
Create a new RoundControl using the given gameState and view +

+

+
Parameters:
gameState - initial game state
view - view used for user interaction
+
+ + + + + + + + +
+Method Detail
+ +

+getEndRoundEvent

+
+public IEvent getEndRoundEvent()
+
+
End the round +

+

+ +
Returns:
endRoundEvent
+
+
+
+ +

+startRound

+
+public void startRound()
+
+
Begin the round +

+

+
+
+
+
+ +

+deal

+
+void deal()
+
+
+
+
+
+
+ +

+tableDifference

+
+static java.util.Set<Stone> tableDifference(ITable oldTable,
+                                            ITable newTable)
+
+
+
+
+
+
+ +

+dealStone

+
+void dealStone()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html b/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html new file mode 100644 index 0000000..a691289 --- /dev/null +++ b/doc/jrummikub/control/TurnControl.HandStonePositionComparator.html @@ -0,0 +1,272 @@ + + + + + + +TurnControl.HandStonePositionComparator + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnControl.HandStonePositionComparator

+
+java.lang.Object
+  extended by jrummikub.control.TurnControl.HandStonePositionComparator
+
+
+
All Implemented Interfaces:
java.util.Comparator<Pair<Stone,Position>>
+
+
+
Enclosing class:
TurnControl
+
+
+
+
static class TurnControl.HandStonePositionComparator
extends java.lang.Object
implements java.util.Comparator<Pair<Stone,Position>>
+ + +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
TurnControl.HandStonePositionComparator() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intcompare(Pair<Stone,Position> pair1, + Pair<Stone,Position> pair2) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface java.util.Comparator
equals
+  +

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

+TurnControl.HandStonePositionComparator

+
+TurnControl.HandStonePositionComparator()
+
+
+ + + + + + + + +
+Method Detail
+ +

+compare

+
+public int compare(Pair<Stone,Position> pair1,
+                   Pair<Stone,Position> pair2)
+
+
+
Specified by:
compare in interface java.util.Comparator<Pair<Stone,Position>>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnControl.html b/doc/jrummikub/control/TurnControl.html new file mode 100644 index 0000000..465384f --- /dev/null +++ b/doc/jrummikub/control/TurnControl.html @@ -0,0 +1,329 @@ + + + + + + +TurnControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnControl

+
+java.lang.Object
+  extended by jrummikub.control.TurnControl
+
+
+
+
public class TurnControl
extends java.lang.Object
+ + +

+Controller for a single turn made by a human player +

+ +

+


+ +

+ + + + + + + + + + + +
+Nested Class Summary
+(package private) static classTurnControl.HandStonePositionComparator + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
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
+  + + + + + + + + + + + + + + + +
+Method Summary
+ IEventgetEndOfTurnEvent() + +
+          Get the event that is emitted when the turn is over
+ voidstartTurn() + +
+          Start the turn
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+TurnControl

+
+public 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. +

+

+
Parameters:
hand - active player's hand
table - current table
view - view for user interaction.
+
+
+ +

+TurnControl

+
+TurnControl(IHand hand,
+            ITable table,
+            IView view,
+            ITurnTimer testTimer)
+
+
Test only constructor +

+

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

+startTurn

+
+public void startTurn()
+
+
Start the turn +

+

+
+
+
+
+ +

+getEndOfTurnEvent

+
+public IEvent getEndOfTurnEvent()
+
+
Get the event that is emitted when the turn is over +

+

+ +
Returns:
end of turn event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/TurnTimer.html b/doc/jrummikub/control/TurnTimer.html new file mode 100644 index 0000000..293a466 --- /dev/null +++ b/doc/jrummikub/control/TurnTimer.html @@ -0,0 +1,342 @@ + + + + + + +TurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +jrummikub.control +
+Class TurnTimer

+
+java.lang.Object
+  extended by jrummikub.control.TurnTimer
+
+
+
All Implemented Interfaces:
java.awt.event.ActionListener, java.util.EventListener, ITurnTimer
+
+
+
+
public class TurnTimer
extends java.lang.Object
implements java.awt.event.ActionListener, ITurnTimer
+ + +

+Count-down timer used to limit the turn time +

+ +

+


+ +

+ + + + + + + + + + + +
+Constructor Summary
TurnTimer(IView view) + +
+          Create a new timer using a given view to display the current time left
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidactionPerformed(java.awt.event.ActionEvent arg0) + +
+           
+ IEventgetTimeRunOutEvent() + +
+          Returns the event that is emitted if the timer timed out.
+ voidstartTimer() + +
+          Starts the timer
+ voidstopTimer() + +
+          Stops the timer.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+TurnTimer

+
+public TurnTimer(IView view)
+
+
Create a new timer using a given view to display the current time left +

+

+
Parameters:
view - view to display
+
+ + + + + + + + +
+Method Detail
+ +

+startTimer

+
+public void startTimer()
+
+
Description copied from interface: ITurnTimer
+
Starts the timer +

+

+
Specified by:
startTimer in interface ITurnTimer
+
+
+
+
+
+
+ +

+stopTimer

+
+public void stopTimer()
+
+
Description copied from interface: ITurnTimer
+
Stops the timer. Stopping an already stopped timer is a no-op. +

+

+
Specified by:
stopTimer in interface ITurnTimer
+
+
+
+
+
+
+ +

+actionPerformed

+
+public void actionPerformed(java.awt.event.ActionEvent arg0)
+
+
+
Specified by:
actionPerformed in interface java.awt.event.ActionListener
+
+
+
+
+
+
+ +

+getTimeRunOutEvent

+
+public IEvent getTimeRunOutEvent()
+
+
Description copied from interface: ITurnTimer
+
Returns the event that is emitted if the timer timed out. +

+

+
Specified by:
getTimeRunOutEvent in interface ITurnTimer
+
+
+ +
Returns:
time out event
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/GameControl.html b/doc/jrummikub/control/class-use/GameControl.html new file mode 100644 index 0000000..c006a28 --- /dev/null +++ b/doc/jrummikub/control/class-use/GameControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.GameControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.GameControl

+
+No usage of jrummikub.control.GameControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/ITurnTimer.html b/doc/jrummikub/control/class-use/ITurnTimer.html new file mode 100644 index 0000000..8730b19 --- /dev/null +++ b/doc/jrummikub/control/class-use/ITurnTimer.html @@ -0,0 +1,197 @@ + + + + + + +Uses of Interface jrummikub.control.ITurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Interface
jrummikub.control.ITurnTimer

+
+ + + + + + + + + +
+Packages that use ITurnTimer
jrummikub.control  
+  +

+ + + + + +
+Uses of ITurnTimer in jrummikub.control
+  +

+ + + + + + + + + +
Classes in jrummikub.control that implement ITurnTimer
+ classTurnTimer + +
+          Count-down timer used to limit the turn time
+  +

+ + + + + + + + +
Constructors in jrummikub.control with parameters of type ITurnTimer
TurnControl(IHand hand, + ITable table, + IView view, + ITurnTimer testTimer) + +
+          Test only constructor
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/RoundControl.html b/doc/jrummikub/control/class-use/RoundControl.html new file mode 100644 index 0000000..b9f8955 --- /dev/null +++ b/doc/jrummikub/control/class-use/RoundControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.RoundControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.RoundControl

+
+No usage of jrummikub.control.RoundControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html b/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html new file mode 100644 index 0000000..592ead4 --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnControl.HandStonePositionComparator.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnControl.HandStonePositionComparator + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnControl.HandStonePositionComparator

+
+No usage of jrummikub.control.TurnControl.HandStonePositionComparator +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnControl.html b/doc/jrummikub/control/class-use/TurnControl.html new file mode 100644 index 0000000..0024dcb --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnControl.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnControl + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnControl

+
+No usage of jrummikub.control.TurnControl +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/class-use/TurnTimer.html b/doc/jrummikub/control/class-use/TurnTimer.html new file mode 100644 index 0000000..a089762 --- /dev/null +++ b/doc/jrummikub/control/class-use/TurnTimer.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class jrummikub.control.TurnTimer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
jrummikub.control.TurnTimer

+
+No usage of jrummikub.control.TurnTimer +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-frame.html b/doc/jrummikub/control/package-frame.html new file mode 100644 index 0000000..d5826e7 --- /dev/null +++ b/doc/jrummikub/control/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +jrummikub.control + + + + + + + + + + + +jrummikub.control + + + + +
+Interfaces  + +
+ITurnTimer
+ + + + + + +
+Classes  + +
+GameControl +
+RoundControl +
+TurnControl +
+TurnControl.HandStonePositionComparator +
+TurnTimer
+ + + + diff --git a/doc/jrummikub/control/package-summary.html b/doc/jrummikub/control/package-summary.html new file mode 100644 index 0000000..e2b2864 --- /dev/null +++ b/doc/jrummikub/control/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +jrummikub.control + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

+Package jrummikub.control +

+ + + + + + + + + +
+Interface Summary
ITurnTimerInterface for the TurnTimer
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
GameControlControls a Game, at some point including all Rounds, starts new Rounds
RoundControlController that manages a single round of rummikub
TurnControlController for a single turn made by a human player
TurnControl.HandStonePositionComparator 
TurnTimerCount-down timer used to limit the turn time
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-tree.html b/doc/jrummikub/control/package-tree.html new file mode 100644 index 0000000..960e887 --- /dev/null +++ b/doc/jrummikub/control/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +jrummikub.control Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Hierarchy For Package jrummikub.control +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/jrummikub/control/package-use.html b/doc/jrummikub/control/package-use.html new file mode 100644 index 0000000..1eb0362 --- /dev/null +++ b/doc/jrummikub/control/package-use.html @@ -0,0 +1,170 @@ + + + + + + +Uses of Package jrummikub.control + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Package
jrummikub.control

+
+ + + + + + + + + +
+Packages that use jrummikub.control
jrummikub.control  
+  +

+ + + + + + + + +
+Classes in jrummikub.control used by jrummikub.control
ITurnTimer + +
+          Interface for the TurnTimer
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + -- cgit v1.2.3