Use a static import.
[Sone.git] / 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.Optional;
23 import com.google.common.base.Predicate;
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         public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
36
37                 /**
38                  * {@inheritDoc}
39                  */
40                 @Override
41                 public int compare(Reply<?> leftReply, Reply<?> rightReply) {
42                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
43                 }
44
45         };
46
47         /** Filter for replies with timestamps from the future. */
48         public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
49
50                 /**
51                  * {@inheritDoc}
52                  */
53                 @Override
54                 public boolean apply(Reply<?> reply) {
55                         return (reply == null) ? false : reply.getTime() <= System.currentTimeMillis();
56                 }
57
58         };
59
60         /**
61          * Returns the ID of the reply.
62          *
63          * @return The ID of the reply
64          */
65         public String getId();
66
67         /**
68          * Returns the Sone that posted this reply.
69          *
70          * @return The Sone that posted this reply
71          */
72         public Sone getSone();
73
74         /**
75          * Returns the time of the reply.
76          *
77          * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
78          */
79         public long getTime();
80
81         /**
82          * Returns the text of the reply.
83          *
84          * @return The text of the reply
85          */
86         public String getText();
87
88         /**
89          * Returns whether this reply is known.
90          *
91          * @return {@code true} if this reply is known, {@code false} otherwise
92          */
93         public boolean isKnown();
94
95         Modifier<T> modify();
96
97         interface Modifier<T> {
98
99                 Modifier<T> setKnown();
100                 T update(Optional<ReplyUpdated<T>> replyUpdated);
101
102                 interface ReplyUpdated<T> {
103
104                         void replyUpdated(T reply);
105
106                 }
107
108         }
109
110 }