summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2011-05-02 04:19:39 +0200
committerMatthias Schiffer <mschiffer@universe-factory.net>2011-05-02 04:19:39 +0200
commit91b921248f4a74bddd8434bcad65c45fd8486549 (patch)
tree69ff1e36447410e367518ecfafa4d99bd9198a52 /src
parente39dc98249e5b71892b4dca0fc0f5ca5e16740a6 (diff)
downloadJRummikub-91b921248f4a74bddd8434bcad65c45fd8486549.tar
JRummikub-91b921248f4a74bddd8434bcad65c45fd8486549.zip
More view JavaDoc
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@63 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src')
-rw-r--r--src/jrummikub/util/Pair.java18
-rw-r--r--src/jrummikub/view/IBoard.java3
-rw-r--r--src/jrummikub/view/IClickable.java3
-rw-r--r--src/jrummikub/view/IPlayerPanel.java5
-rw-r--r--src/jrummikub/view/IStoneCollection.java3
-rw-r--r--src/jrummikub/view/ITable.java3
-rw-r--r--src/jrummikub/view/IView.java3
7 files changed, 35 insertions, 3 deletions
diff --git a/src/jrummikub/util/Pair.java b/src/jrummikub/util/Pair.java
index 5fb8589..76eea4f 100644
--- a/src/jrummikub/util/Pair.java
+++ b/src/jrummikub/util/Pair.java
@@ -2,20 +2,34 @@ package jrummikub.util;
/**
* A pair of objects
+ * @param <T1> the first type of the pair
+ * @param <T2> the second type of the pair
*/
public class Pair<T1, T2> {
- final T1 first;
- final T2 second;
+ private final T1 first;
+ private final T2 second;
+ /**
+ * Create a new pair
+ *
+ * @param first the first value
+ * @param second the second value
+ */
public Pair(T1 first, T2 second) {
this.first = first;
this.second = second;
}
+ /**
+ * @return the first value
+ */
public T1 getFirst() {
return first;
}
+ /**
+ * @return the first value
+ */
public T2 getSecond() {
return second;
}
diff --git a/src/jrummikub/view/IBoard.java b/src/jrummikub/view/IBoard.java
index 0816937..1424dff 100644
--- a/src/jrummikub/view/IBoard.java
+++ b/src/jrummikub/view/IBoard.java
@@ -5,6 +5,9 @@ import java.util.Map;
import jrummikub.model.Position;
import jrummikub.model.Stone;
+/**
+ * The view for a player's board that displayed his stones
+ */
public interface IBoard extends IClickable {
/**
* Set the player's stones to display on the board
diff --git a/src/jrummikub/view/IClickable.java b/src/jrummikub/view/IClickable.java
index 818e4fa..c827042 100644
--- a/src/jrummikub/view/IClickable.java
+++ b/src/jrummikub/view/IClickable.java
@@ -3,6 +3,9 @@ package jrummikub.view;
import jrummikub.model.Position;
import jrummikub.util.IEvent2;
+/**
+ * An interface for view elements that can emit click events
+ */
public interface IClickable {
/**
* the click event is emitted when the player clicks on the table/board/etc.
diff --git a/src/jrummikub/view/IPlayerPanel.java b/src/jrummikub/view/IPlayerPanel.java
index 4cddfa4..e39ab65 100644
--- a/src/jrummikub/view/IPlayerPanel.java
+++ b/src/jrummikub/view/IPlayerPanel.java
@@ -2,9 +2,12 @@ package jrummikub.view;
import jrummikub.util.IEvent;
+/**
+ * The player panel that contains a player's board and other user interfaces
+ */
public interface IPlayerPanel {
/**
- * @return
+ * @return the board where the players hand stones are displayed
*/
public IBoard getBoard();
diff --git a/src/jrummikub/view/IStoneCollection.java b/src/jrummikub/view/IStoneCollection.java
index 2ef9c79..8b4148d 100644
--- a/src/jrummikub/view/IStoneCollection.java
+++ b/src/jrummikub/view/IStoneCollection.java
@@ -1,4 +1,7 @@
package jrummikub.view;
+/**
+ * The view of the collection that shows the stones a player has selected
+ */
public interface IStoneCollection extends IClickable {
}
diff --git a/src/jrummikub/view/ITable.java b/src/jrummikub/view/ITable.java
index 258263a..e257d26 100644
--- a/src/jrummikub/view/ITable.java
+++ b/src/jrummikub/view/ITable.java
@@ -5,6 +5,9 @@ import java.util.Map;
import jrummikub.model.Position;
import jrummikub.model.StoneSet;
+/**
+ * The view of the table, where the stone sets lie
+ */
public interface ITable extends IClickable {
/**
* Sets the player name on the left label
diff --git a/src/jrummikub/view/IView.java b/src/jrummikub/view/IView.java
index 419a2c1..25ebb32 100644
--- a/src/jrummikub/view/IView.java
+++ b/src/jrummikub/view/IView.java
@@ -4,6 +4,9 @@ import java.util.Collection;
import jrummikub.model.Stone;
+/**
+ * The top-level view interface
+ */
public interface IView {
/**
* Returns the table