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

   1 /*
   2  * Sone - PostStore.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 java.util.Collection;
  21
  22 import net.pterodactylus.sone.data.Post;
  23 import net.pterodactylus.sone.data.Sone;
  24
  25 /**
  26  * Interface for a store for posts.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public interface PostStore {
  31
  32         /**
  33          * Adds the given post to the store.
  34          *
  35          * @param post
  36          *            The post to store
  37          */
  38         public void storePost(Post post);
  39
  40         /**
  41          * Removes the given post.
  42          *
  43          * @param post
  44          *            The post to remove
  45          */
  46         public void removePost(Post post);
  47
  48         /**
  49          * Stores the given posts as all posts of a single {@link Sone}. This method
  50          * will removed all other posts from the Sone!
  51          *
  52          * @param sone
  53          *            The Sone to store the posts for
  54          * @param posts
  55          *            The posts to store
  56          * @throws IllegalArgumentException
  57          *             if posts do not all belong to the same Sone
  58          */
  59         public void storePosts(Sone sone, Collection<Post> posts) throws IllegalArgumentException;
  60
  61         /**
  62          * Removes all posts of the given {@link Sone}
  63          *
  64          * @param sone
  65          *            The Sone to remove all posts for
  66          */
  67         public void removePosts(Sone sone);
  68
  69 }