core/PostReplyProvider.java

   1 /*
   2  * Sone - PostReplyProvider.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.core;
  19
  20 import java.util.List;
  21
  22 import net.pterodactylus.sone.data.Post;
  23 import net.pterodactylus.sone.data.PostReply;
  24
  25 /**
  26  * Interface for objects that can provide {@link PostReply}s.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public interface PostReplyProvider {
  31
  32         /**
  33          * Returns the reply with the given ID.
  34          *
  35          * @param id
  36          *            The ID of the reply to get
  37          * @return The reply, or {@code null} if there is no such reply
  38          */
  39         public PostReply getPostReply(String id);
  40
  41         /**
  42          * Returns all replies for the given post, order ascending by time.
  43          *
  44          * @param post
  45          *            The post to get all replies for
  46          * @return All replies for the given post
  47          */
  48         public List<PostReply> getReplies(Post post);
  49
  50 }