src/main/java/net/pterodactylus/sone/data/PostReply.java

   1 /*
   2  * Sone - PostReply.java - Copyright © 2010–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.data;
  19
  20 import com.google.common.base.Optional;
  21 import com.google.common.base.Predicate;
  22
  23 /**
  24  * A reply is like a {@link Post} but can never be posted on its own, it always
  25  * refers to another {@link Post}.
  26  *
  27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  28  */
  29 public interface PostReply extends Reply<PostReply> {
  30
  31         /**
  32          * Filter that selects {@link PostReply}s that have a
  33          * {@link Optional#isPresent() present} {@link #getPost() post}.
  34          */
  35         public static final Predicate<PostReply> HAS_POST_FILTER = new Predicate<PostReply>() {
  36
  37                 @Override
  38                 public boolean apply(PostReply postReply) {
  39                         return postReply.getPost().isPresent();
  40                 }
  41         };
  42
  43         /**
  44          * Returns the ID of the post this reply refers to.
  45          *
  46          * @return The ID of the post this reply refers to
  47          */
  48         public String getPostId();
  49
  50         /**
  51          * Returns the post this reply refers to.
  52          *
  53          * @return The post this reply refers to
  54          */
  55         public Optional<Post> getPost();
  56
  57 }