Add javadoc.
[demoscenemusic.git] / src / main / java / net / pterodactylus / demoscenemusic / data / Party.java
index dbf1b8e..8ce4bcc 100644 (file)
 package net.pterodactylus.demoscenemusic.data;
 
 /**
- * TODO
+ * Data interface for parties.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Party extends AbstractBase {
+public interface Party extends Base {
 
-       private String name;
+       /**
+        * Returns the name of this party.
+        *
+        * @return The name of this party
+        */
+       public String getName();
 
-       public Party(String id) {
-               super(id);
-       }
-
-       public String name() {
-               return name;
-       }
-
-       public Party name(String name) {
-               this.name = name;
-               return this;
-       }
+       /**
+        * Sets the name of this party.
+        *
+        * @param name
+        *            The name of this party
+        * @return This party
+        */
+       public Party setName(String name);
 
 }