From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Sat, 2 Feb 2013 21:49:19 +0000 (+0100)
Subject: Add post database interface.
X-Git-Tag: 0.8.5^2~3^2~21
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=cf10defb0a5f633941427d56238298f1539790ed;p=Sone.git

Add post database interface.
---

diff --git a/src/main/java/net/pterodactylus/sone/database/PostDatabase.java b/src/main/java/net/pterodactylus/sone/database/PostDatabase.java
new file mode 100644
index 0000000..1f9a2a8
--- /dev/null
+++ b/src/main/java/net/pterodactylus/sone/database/PostDatabase.java
@@ -0,0 +1,58 @@
+/*
+ * Sone - PostDatabase.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 net.pterodactylus.util.config.Configuration;
+import net.pterodactylus.util.config.ConfigurationException;
+
+/**
+ * Combines a {@link PostProvider}, a {@link PostBuilderFactory}, and a
+ * {@link PostStore} into a complete post database.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface PostDatabase extends PostProvider, PostBuilderFactory, PostStore {
+
+	/*
+	 * these methods have to be here until the database knows how to save its
+	 * own stuff. all the configuration-specific stuff will have to leave!
+	 */
+
+	/**
+	 * Loads the knows posts.
+	 *
+	 * @param configuration
+	 *            The configuration to load the known posts from
+	 * @param prefix
+	 *            The prefix for the configuration keys
+	 */
+	public void loadKnownPosts(Configuration configuration, String prefix);
+
+	/**
+	 * Saves the knows posts.
+	 *
+	 * @param configuration
+	 *            The configuration to save the known posts to
+	 * @param prefix
+	 *            The prefix for the configuration keys
+	 * @throws ConfigurationException
+	 *             if a value can not be stored in the configuration
+	 */
+	public void saveKnownPosts(Configuration configuration, String prefix) throws ConfigurationException;
+
+}