summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/control/ITurnTimer.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jrummikub/control/ITurnTimer.java')
-rw-r--r--src/jrummikub/control/ITurnTimer.java14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/jrummikub/control/ITurnTimer.java b/src/jrummikub/control/ITurnTimer.java
index 54f00b5..175d95f 100644
--- a/src/jrummikub/control/ITurnTimer.java
+++ b/src/jrummikub/control/ITurnTimer.java
@@ -2,12 +2,26 @@ package jrummikub.control;
import jrummikub.util.IEvent;
+/**
+ * Interface for the {@link TurnTimer}
+ */
public interface ITurnTimer {
+ /**
+ * Starts the timer
+ */
public abstract void startTimer();
+ /**
+ * Stops the timer. Stopping an already stopped timer is a no-op.
+ */
public abstract void stopTimer();
+ /**
+ * Returns the event that is emitted if the timer timed out.
+ *
+ * @return time out event
+ */
public abstract IEvent getTimeRunOutEvent();
} \ No newline at end of file