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 import java.util.Set;
  22
  23 import com.google.common.base.Optional;
  24 import com.google.common.base.Predicate;
  25
  26 /**
  27  * Defines methods common for all replies.
  28  *
  29  * @param <T>
  30  *            The type of the reply
  31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  32  */
  33 public interface Reply<T extends Reply<T>> extends Identified {
  34
  35         /** Comparator that sorts replies ascending by time. */
  36         public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
  37
  38                 /**
  39                  * {@inheritDoc}
  40                  */
  41                 @Override
  42                 public int compare(Reply<?> leftReply, Reply<?> rightReply) {
  43                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
  44                 }
  45
  46         };
  47
  48         /** Filter for replies with timestamps from the future. */
  49         public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
  50
  51                 /**
  52                  * {@inheritDoc}
  53                  */
  54                 @Override
  55                 public boolean apply(Reply<?> reply) {
  56                         return (reply == null) ? false : reply.getTime() <= System.currentTimeMillis();
  57                 }
  58
  59         };
  60
  61         /**
  62          * Returns the ID of the reply.
  63          *
  64          * @return The ID of the reply
  65          */
  66         public String getId();
  67
  68         /**
  69          * Returns the Sone that posted this reply.
  70          *
  71          * @return The Sone that posted this reply
  72          */
  73         public Sone getSone();
  74
  75         /**
  76          * Returns the time of the reply.
  77          *
  78          * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
  79          */
  80         public long getTime();
  81
  82         /**
  83          * Returns the text of the reply.
  84          *
  85          * @return The text of the reply
  86          */
  87         public String getText();
  88
  89         /**
  90          * Returns whether this reply is known.
  91          *
  92          * @return {@code true} if this reply is known, {@code false} otherwise
  93          */
  94         public boolean isKnown();
  95
  96         void like(Sone localSone);
  97         void unlike(Sone localSone);
  98
  99         boolean isLiked(Sone sone);
 100         Set<Sone> getLikes();
 101
 102         Modifier<T> modify();
 103
 104         interface Modifier<T> {
 105
 106                 Modifier<T> setKnown();
 107                 T update(Optional<ReplyUpdated<T>> replyUpdated);
 108
 109                 interface ReplyUpdated<T> {
 110
 111                         void replyUpdated(T reply);
 112
 113                 }
 114
 115         }
 116
 117 }