Clarify Javadocs API

jcartign
1 parent c07d86ab
Showing 4 changed files with 15 additions and 2 deletions Show diff stats
src/main/java/fr/plil/sio/persistence/api/Group.java
src/main/java/fr/plil/sio/persistence/api/GroupService.java
src/main/java/fr/plil/sio/persistence/api/Right.java
src/main/java/fr/plil/sio/persistence/api/User.java
@@ -3,6 +3,10 @@ package fr.plil.sio.persistence.api;
 import java.util.LinkedList;
 import java.util.List;
  
+/**
+ * A group is unique by its name (no two groups with the same name or the same ID can exist in the database).
+ * A group contains a list of rights unique by their ID (no two groups with the same ID can exist in the database).
+ */
 public class Group {
  
     private Long id;
@@ -4,7 +4,7 @@ public interface GroupService {
  
     /**
      * Create a group with a specific name in the database.
-     * There is no two groups with the same name in the database.
+     * There is no two groups with the same name or the same ID in the database.
      *
      * @param name the name of the group
      * @return an instance of the group
@@ -23,7 +23,7 @@ public interface GroupService {
     boolean delete(String name);
  
     /**
-     * Find a group in the database based on its name. Only references at one level are available (i.e. the users
+     * Find a group in the database based on its name. Only references at one level are loaded (i.e. the users
      * who belong to the group).
      *
      * @param name the name of the group to search for.
@@ -3,6 +3,11 @@ package fr.plil.sio.persistence.api;
 import java.util.LinkedList;
 import java.util.List;
  
+/**
+ * A right is unique by itd ID, i.e. it can exist two rights with the same name in the database.
+ * A right may have a parent, null else.
+ * A right can have zero, one or more siblings.
+ */
 public class Right {
  
     private Long id;
 package fr.plil.sio.persistence.api;
  
+/**
+ * An user MUST have a group in the database.
+ * An user is unique by it name, i.e. database cannot contain two user with the same name or the same ID.
+ */
 public class User {
  
     private Long id;