src/main/java/net/pterodactylus/sone/database/PostDatabase.java

   1 /*
   2  * Sone - PostDatabase.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.database;
  19
  20 import net.pterodactylus.util.config.Configuration;
  21 import net.pterodactylus.util.config.ConfigurationException;
  22
  23 /**
  24  * Combines a {@link PostProvider}, a {@link PostBuilderFactory}, and a
  25  * {@link PostStore} into a complete post database.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public interface PostDatabase extends PostProvider, PostBuilderFactory, PostStore {
  30
  31         /*
  32          * these methods have to be here until the database knows how to save its
  33          * own stuff. all the configuration-specific stuff will have to leave!
  34          */
  35
  36         /**
  37          * Loads the knows posts.
  38          *
  39          * @param configuration
  40          *            The configuration to load the known posts from
  41          * @param prefix
  42          *            The prefix for the configuration keys
  43          */
  44         public void loadKnownPosts(Configuration configuration, String prefix);
  45
  46         /**
  47          * Saves the knows posts.
  48          *
  49          * @param configuration
  50          *            The configuration to save the known posts to
  51          * @param prefix
  52          *            The prefix for the configuration keys
  53          * @throws ConfigurationException
  54          *             if a value can not be stored in the configuration
  55          */
  56         public void saveKnownPosts(Configuration configuration, String prefix) throws ConfigurationException;
  57
  58 }