Add and use memory-based post reply implementation.

[Sone.git] / src / main / java / net / pterodactylus / sone / database / PostReplyStore.java

diff --git a/src/main/java/net/pterodactylus/sone/database/PostReplyStore.java b/src/main/java/net/pterodactylus/sone/database/PostReplyStore.java
new file mode 100644 (file)
index 0000000..a3cefb3
--- /dev/null
+++ b/src/main/java/net/pterodactylus/sone/database/PostReplyStore.java
@@ -0,0 +1,69 @@
+/*
+ * Sone - PostReplyStore.java - Copyright © 2013 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.database;
+
+import java.util.Collection;
+
+import net.pterodactylus.sone.data.PostReply;
+import net.pterodactylus.sone.data.Sone;
+
+/**
+ * Defines a store for {@link PostReply post replies}.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface PostReplyStore {
+
+       /**
+        * Stores the given post reply.
+        *
+        * @param postReply
+        *            The post reply
+        */
+       public void storePostReply(PostReply postReply);
+
+       /**
+        * Stores the given post replies as exclusive collection of post replies for
+        * the given Sone. This will remove all other post replies from this Sone!
+        *
+        * @param sone
+        *            The Sone to store all post replies for
+        * @param postReplies
+        *            The post replies of the Sone
+        * @throws IllegalArgumentException
+        *             if one of the replies does not belong to the given Sone
+        */
+       public void storePostReplies(Sone sone, Collection<PostReply> postReplies) throws IllegalArgumentException;
+
+       /**
+        * Removes the given post reply from this store.
+        *
+        * @param postReply
+        *            The post reply to remove
+        */
+       public void removePostReply(PostReply postReply);
+
+       /**
+        * Removes all post replies of the given Sone.
+        *
+        * @param sone
+        *            The Sone to remove all post replies for
+        */
+       public void removePostReplies(Sone sone);
+
+}