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

   1 /*
   2  * Sone - Reply.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 java.util.Comparator;
  21
  22 import com.google.common.base.Predicate;
  23 import com.google.common.primitives.Longs;
  24
  25 /**
  26  * Defines methods common for all replies.
  27  *
  28  * @param <T>
  29  *            The type of the reply
  30  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  31  */
  32 public interface Reply<T extends Reply<T>> extends Identified {
  33
  34         /** Comparator that sorts replies ascending by time. */
  35         Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
  36                 @Override
  37                 public int compare(Reply<?> leftReply, Reply<?> rightReply) {
  38                         return Longs.compare(leftReply.getTime(), rightReply.getTime());
  39                 }
  40         };
  41
  42         /** Filter for replies with timestamps from the future. */
  43         Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
  44                 @Override
  45                 public boolean apply(Reply<?> reply) {
  46                         return (reply != null) && (reply.getTime() <= System.currentTimeMillis());
  47                 }
  48         };
  49
  50         /**
  51          * Returns the ID of the reply.
  52          *
  53          * @return The ID of the reply
  54          */
  55         String getId();
  56         String getInternalId();
  57
  58         /**
  59          * Returns the Sone that posted this reply.
  60          *
  61          * @return The Sone that posted this reply
  62          */
  63         Sone getSone();
  64
  65         /**
  66          * Returns the time of the reply.
  67          *
  68          * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
  69          */
  70         long getTime();
  71
  72         /**
  73          * Returns the text of the reply.
  74          *
  75          * @return The text of the reply
  76          */
  77         String getText();
  78
  79         /**
  80          * Returns whether this reply is known.
  81          *
  82          * @return {@code true} if this reply is known, {@code false} otherwise
  83          */
  84         boolean isKnown();
  85
  86         /**
  87          * Sets whether this reply is known.
  88          *
  89          * @param known
  90          *              {@code true} if this reply is known, {@code false} otherwise
  91          * @return This reply
  92          */
  93         T setKnown(boolean known);
  94
  95 }