Use a static import.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Post.java
1 /*
2  * Sone - Post.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.Collections;
21 import java.util.Comparator;
22 import java.util.List;
23
24 import com.google.common.base.Function;
25 import com.google.common.base.Optional;
26 import com.google.common.base.Predicate;
27
28 /**
29  * A post is a short message that a user writes in his Sone to let other users
30  * know what is going on.
31  *
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 public interface Post extends Identified {
35
36         /** Comparator for posts, sorts descending by time. */
37         public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
38
39                 @Override
40                 public int compare(Post leftPost, Post rightPost) {
41                         return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
42                 }
43
44         };
45
46         /** Filter for posts with timestamps from the future. */
47         public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
48
49                 @Override
50                 public boolean apply(Post post) {
51                         return (post == null) ? false : post.getTime() <= System.currentTimeMillis();
52                 }
53
54         };
55
56         public static final Function<Post, List<PostReply>> TO_REPLIES = new Function<Post, List<PostReply>>() {
57                 @Override
58                 public List<PostReply> apply(Post post) {
59                         return (post == null) ? Collections.<PostReply>emptyList() : post.getReplies();
60                 }
61         };
62
63         //
64         // ACCESSORS
65         //
66
67         /**
68          * Returns the ID of the post.
69          *
70          * @return The ID of the post
71          */
72         public String getId();
73
74         /**
75          * Returns the Sone this post belongs to.
76          *
77          * @return The Sone of this post
78          */
79         public Sone getSone();
80
81         /**
82          * Returns the ID of the recipient {@link Sone}, or
83          * {@link Optional#absent()} if this post does not have a recipient.
84          *
85          * @return The ID of the recipient, or {@link Optional#absent()}
86          */
87         public Optional<String> getRecipientId();
88
89         /**
90          * Returns the recipient of this post, if any.
91          *
92          * @return The recipient of this post, or {@link Optional#absent()} if there
93          *         is no recipient
94          */
95         public Optional<Sone> getRecipient();
96
97         /**
98          * Returns the time of the post.
99          *
100          * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
101          */
102         public long getTime();
103
104         /**
105          * Returns the text of the post.
106          *
107          * @return The text of the post
108          */
109         public String getText();
110
111         /**
112          * Returns whether this post is known.
113          *
114          * @return {@code true} if this post is known, {@code false} otherwise
115          */
116         public boolean isKnown();
117
118         /**
119          * Sets whether this post is known.
120          *
121          * @param known
122          *            {@code true} if this post is known, {@code false} otherwise
123          * @return This post
124          */
125         public Post setKnown(boolean known);
126
127         List<PostReply> getReplies();
128
129 }