more javadocs and cleanup

1 files changed, 19 insertions, 8 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
index 6052e4f..15f8442 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
@@ -6,22 +6,27 @@ import java.util.Arrays;
 import com.ufund.api.ufundapi.model.Need;
 import com.ufund.api.ufundapi.persistence.CupboardDAO;
 import org.springframework.stereotype.Component;
+import com.ufund.api.ufundapi.DuplicateKeyException;
 
 @Component
 public class CupboardService {
 
     private final CupboardDAO cupboardDAO;
 
-    public class DuplicateKeyException extends Exception {
-        public DuplicateKeyException(String message) {
-            super(message);
-        }
-    }
-
     public CupboardService(CupboardDAO cupboardDAO) {
         this.cupboardDAO = cupboardDAO;
     }
 
+    /**
+     * Creates a new Need
+     *
+     * @param name The name of the need to create
+     * @param maxGoal The max goal of the new need
+     * @param goalType The goal type of the new need
+     * @return The need that was created
+     * @throws IOException Thrown if there was any issue saving the data
+     * @throws DuplicateKeyException If there already exists a need with the same name
+     */
     public Need createNeed(String name, int maxGoal, Need.GoalType goalType) throws IOException, DuplicateKeyException {
         
         Need need = new Need(name, goalType, maxGoal);
@@ -39,6 +44,12 @@ public class CupboardService {
         
     }
 
+    /**
+     * Get all the needs in the cupboard
+     *
+     * @return An array containing all needs
+     * @throws IOException Thrown if there was any issue saving the data
+     */
     public Need[] getNeeds() throws IOException {
         return cupboardDAO.getNeeds();
     }
@@ -48,7 +59,7 @@ public class CupboardService {
      *
      * @param search The search substring
      * @return The requested array
-     * @throws IOException 
+     * @throws IOException Thrown if there was any issue saving the data
      */
     public Need[] searchNeeds(String search) throws IOException {
         return Arrays.stream(cupboardDAO.getNeeds())
@@ -68,7 +79,7 @@ public class CupboardService {
 
     /**
      * Modify a need
-     *
+     * // TODO
      * @param need
      * @return
      * @throws IOException Thrown if there was an issue saving the changes