aboutsummaryrefslogtreecommitdiff
path: root/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java
diff options
context:
space:
mode:
authorsowgro <tpoke.ferrari@gmail.com>2025-02-16 13:26:43 -0500
committersowgro <tpoke.ferrari@gmail.com>2025-02-16 13:26:43 -0500
commita4aa226955df2284a298b6ae35ee72d4996978a3 (patch)
treeaad3d8d420402298a112dc3c4952599f4aba6d4d /ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java
parentb7c662afadf531eae34c5044c50c7b5c5330345b (diff)
downloadJellySolutions-a4aa226955df2284a298b6ae35ee72d4996978a3.tar.gz
JellySolutions-a4aa226955df2284a298b6ae35ee72d4996978a3.tar.bz2
JellySolutions-a4aa226955df2284a298b6ae35ee72d4996978a3.zip
Implement FileDAO
Diffstat (limited to 'ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java')
-rw-r--r--ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java12
1 files changed, 6 insertions, 6 deletions
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java
index 4b016fa..1435410 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/CupboardDAO.java
@@ -22,9 +22,9 @@ public interface CupboardDAO {
/**
* Finds all {@linkplain Need needs} whose name contains the given text
*
- * @param containsText The text to match against
+ * @param targetName The text to match against
*
- * @return An array of {@link Need needs} whose nemes contains the given text, may be empty
+ * @return An array of {@link Need needs} whose names contains the given text, may be empty
*
* @throws IOException if an issue with underlying storage
*/
@@ -33,7 +33,7 @@ public interface CupboardDAO {
/**
* Retrieves a {@linkplain Need need} with the given name
*
- * @param name The name of the {@link Need need} to get
+ * @param id The ID of the {@link Need need} to get
*
* @return a {@link Need need} object with the matching name
* <br>
@@ -50,7 +50,7 @@ public interface CupboardDAO {
* <br>
* The id of the need object is automatically incremented.
*
- * @return new {@link Need need} if successful, false otherwise
+ * @return new {@link Need need} if successful, null otherwise
*
* @throws IOException if an issue with underlying storage
*/
@@ -59,7 +59,7 @@ public interface CupboardDAO {
/**
* Updates and saves a {@linkplain Need need}
*
- * @param {@link Need need} object to be updated and saved
+ * @param need {@link Need need} object to be updated and saved
*
* @return updated {@link Need need} if successful, null if
* {@link Need need} could not be found
@@ -75,7 +75,7 @@ public interface CupboardDAO {
*
* @return true if the {@link Need need} was deleted
* <br>
- * false if need with the given id does not exist
+ * false if the need with the given id does not exist
*
* @throws IOException if underlying storage cannot be accessed
*/