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;
22 import com.google.common.base.Predicate;
25 * Defines methods common for all replies.
28 * The type of the reply
29 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
31 public interface Reply<T extends Reply<T>> {
33 /** Comparator that sorts replies ascending by time. */
34 public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
40 public int compare(Reply<?> leftReply, Reply<?> rightReply) {
41 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
46 /** Filter for replies with timestamps from the future. */
47 public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
53 public boolean apply(Reply<?> reply) {
54 return reply.getTime() <= System.currentTimeMillis();
60 * Returns the ID of the reply.
62 * @return The ID of the reply
64 public String getId();
67 * Returns the Sone that posted this reply.
69 * @return The Sone that posted this reply
71 public Sone getSone();
74 * Returns the time of the reply.
76 * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
78 public long getTime();
81 * Returns the text of the reply.
83 * @return The text of the reply
85 public String getText();
88 * Returns whether this reply is known.
90 * @return {@code true} if this reply is known, {@code false} otherwise
92 public boolean isKnown();
95 * Sets whether this reply is known.
98 * {@code true} if this reply is known, {@code false} otherwise
101 public T setKnown(boolean known);