🚨 Add @Nonnull annotation
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Reply.java
1 /*
2  * Sone - Reply.java - Copyright Â© 2010–2019 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
24 /**
25  * Defines methods common for all replies.
26  *
27  * @param <T>
28  *            The type of the reply
29  */
30 public interface Reply<T extends Reply<T>> extends Identified {
31
32         /** Comparator that sorts replies ascending by time. */
33         public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
34
35                 /**
36                  * {@inheritDoc}
37                  */
38                 @Override
39                 public int compare(Reply<?> leftReply, Reply<?> rightReply) {
40                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
41                 }
42
43         };
44
45         /** Filter for replies with timestamps from the future. */
46         public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
47
48                 /**
49                  * {@inheritDoc}
50                  */
51                 @Override
52                 public boolean apply(Reply<?> reply) {
53                         return (reply != null) && (reply.getTime() <= System.currentTimeMillis());
54                 }
55
56         };
57
58         /**
59          * Returns the ID of the reply.
60          *
61          * @return The ID of the reply
62          */
63         public String getId();
64
65         /**
66          * Returns the Sone that posted this reply.
67          *
68          * @return The Sone that posted this reply
69          */
70         public Sone getSone();
71
72         /**
73          * Returns the time of the reply.
74          *
75          * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
76          */
77         public long getTime();
78
79         /**
80          * Returns the text of the reply.
81          *
82          * @return The text of the reply
83          */
84         public String getText();
85
86         /**
87          * Returns whether this reply is known.
88          *
89          * @return {@code true} if this reply is known, {@code false} otherwise
90          */
91         public boolean isKnown();
92
93         /**
94          * Sets whether this reply is known.
95          *
96          * @param known
97          *            {@code true} if this reply is known, {@code false} otherwise
98          * @return This reply
99          */
100         public T setKnown(boolean known);
101
102 }