summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/model/IPlayer.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jrummikub/model/IPlayer.java')
-rw-r--r--src/jrummikub/model/IPlayer.java18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/jrummikub/model/IPlayer.java b/src/jrummikub/model/IPlayer.java
index 17e37e7..3eca44b 100644
--- a/src/jrummikub/model/IPlayer.java
+++ b/src/jrummikub/model/IPlayer.java
@@ -2,12 +2,30 @@ package jrummikub.model;
import java.awt.Color;
+/**
+ * Interface for {@link Player} model
+ */
public interface IPlayer {
+ /**
+ * Get the current hand of the player
+ *
+ * @return the player's hand
+ */
public IHand getHand();
+ /**
+ * Return the player's color
+ *
+ * @return the player's color
+ */
public Color getColor();
+ /**
+ * Return the name of the player
+ *
+ * @return the player's name
+ */
public String getName();
} \ No newline at end of file