diff options
| author | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-10 03:54:48 +0200 |
|---|---|---|
| committer | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-10 03:54:48 +0200 |
| commit | 3b49b2053e9f9d26b73db0ffc8380a60706ee095 (patch) | |
| tree | 9678d5abb4af070bbf0fd89c684e91f5fd472c31 /src/jrummikub/model/ITable.java | |
| parent | 4a860e53cf6f2f97f18785673399498609e6504b (diff) | |
| download | JRummikub-3b49b2053e9f9d26b73db0ffc8380a60706ee095.tar JRummikub-3b49b2053e9f9d26b73db0ffc8380a60706ee095.zip | |
Added all missing comments
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@213 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src/jrummikub/model/ITable.java')
| -rw-r--r-- | src/jrummikub/model/ITable.java | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/src/jrummikub/model/ITable.java b/src/jrummikub/model/ITable.java index 1c3fd9f..3b0032f 100644 --- a/src/jrummikub/model/ITable.java +++ b/src/jrummikub/model/ITable.java @@ -2,20 +2,32 @@ package jrummikub.model; import jrummikub.util.Pair;
+/**
+ * Interface for the {@link Table} model
+ */
public interface ITable extends IStoneTray<StoneSet> {
/**
* Removes {@link Stone} from the Table
*
* @param stone
- * stone to pick up
+ * stone to pick up
* @return the stone sets that are created by taking pickung the the stone
*/
public Pair<StoneSet, StoneSet> pickUpStone(Stone stone);
- /** Tests the Table for rule conflicts by checking all the {@link StoneSet} */
+ /**
+ * Tests the Table for rule conflicts by checking all the {@link StoneSet}
+ *
+ * @return whether all sets on the table are valid
+ */
public boolean isValid();
+ /**
+ * Finds the {@link StoneSet} containing the given {@link Stone}
+ * @param stone stone whose set we're searching
+ * @return the set containing the stone or null if no set was found
+ */
StoneSet findStoneSet(Stone stone);
}
\ No newline at end of file |