2 * Sone - Reply.java - Copyright © 2010–2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.data;
20 import java.util.Comparator;
23 import com.google.common.base.Optional;
24 import com.google.common.base.Predicate;
27 * Defines methods common for all replies.
30 * The type of the reply
31 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33 public interface Reply<T extends Reply<T>> extends Identified {
35 /** Comparator that sorts replies ascending by time. */
36 public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
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()));
48 /** Filter for replies with timestamps from the future. */
49 public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
55 public boolean apply(Reply<?> reply) {
56 return (reply == null) ? false : reply.getTime() <= System.currentTimeMillis();
62 * Returns the ID of the reply.
64 * @return The ID of the reply
66 public String getId();
69 * Returns the Sone that posted this reply.
71 * @return The Sone that posted this reply
73 public Sone getSone();
76 * Returns the time of the reply.
78 * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
80 public long getTime();
83 * Returns the text of the reply.
85 * @return The text of the reply
87 public String getText();
90 * Returns whether this reply is known.
92 * @return {@code true} if this reply is known, {@code false} otherwise
94 public boolean isKnown();
96 void like(Sone localSone);
97 void unlike(Sone localSone);
99 boolean isLiked(Sone sone);
100 Set<Sone> getLikes();
102 Modifier<T> modify();
104 interface Modifier<T> {
106 Modifier<T> setKnown();
107 T update(Optional<ReplyUpdated<T>> replyUpdated);
109 interface ReplyUpdated<T> {
111 void replyUpdated(T reply);