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

   1 /*
   2  * Sone - PostReplyStore.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.PostReply;
  23 import net.pterodactylus.sone.data.Sone;
  24
  25 /**
  26  * Defines a store for {@link PostReply post replies}.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public interface PostReplyStore {
  31
  32         /**
  33          * Stores the given post reply.
  34          *
  35          * @param postReply
  36          *            The post reply
  37          */
  38         public void storePostReply(PostReply postReply);
  39
  40         /**
  41          * Stores the given post replies as exclusive collection of post replies for
  42          * the given Sone. This will remove all other post replies from this Sone!
  43          *
  44          * @param sone
  45          *            The Sone to store all post replies for
  46          * @param postReplies
  47          *            The post replies of the Sone
  48          * @throws IllegalArgumentException
  49          *             if one of the replies does not belong to the given Sone
  50          */
  51         public void storePostReplies(Sone sone, Collection<PostReply> postReplies) throws IllegalArgumentException;
  52
  53         /**
  54          * Removes the given post reply from this store.
  55          *
  56          * @param postReply
  57          *            The post reply to remove
  58          */
  59         public void removePostReply(PostReply postReply);
  60
  61         /**
  62          * Removes all post replies of the given Sone.
  63          *
  64          * @param sone
  65          *            The Sone to remove all post replies for
  66          */
  67         public void removePostReplies(Sone sone);
  68
  69 }