2 * Sone - Post.java - Copyright © 2010–2015 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 static com.google.common.base.Optional.absent;
22 import java.util.Comparator;
24 import com.google.common.base.Optional;
25 import com.google.common.base.Predicate;
28 * A post is a short message that a user writes in his Sone to let other users
29 * know what is going on.
31 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33 public interface Post extends Identified {
35 /** Comparator for posts, sorts descending by time. */
36 public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
39 public int compare(Post leftPost, Post rightPost) {
40 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
45 /** Filter for posts with timestamps from the future. */
46 public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
49 public boolean apply(Post post) {
50 return (post != null) && (post.getTime() <= System.currentTimeMillis());
60 * Returns the ID of the post.
62 * @return The ID of the post
64 public String getId();
67 * Returns whether this post has already been loaded.
69 * @return {@code true} if this post has already been loaded, {@code
75 * Returns the Sone this post belongs to.
77 * @return The Sone of this post
79 public Sone getSone();
82 * Returns the ID of the recipient {@link Sone}, or
83 * {@link Optional#absent()} if this post does not have a recipient.
85 * @return The ID of the recipient, or {@link Optional#absent()}
87 public Optional<String> getRecipientId();
90 * Returns the recipient of this post, if any.
92 * @return The recipient of this post, or {@link Optional#absent()} if there
95 public Optional<Sone> getRecipient();
98 * Returns the time of the post.
100 * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
102 public long getTime();
105 * Returns the text of the post.
107 * @return The text of the post
109 public String getText();
112 * Returns whether this post is known.
114 * @return {@code true} if this post is known, {@code false} otherwise
116 public boolean isKnown();
119 * Sets whether this post is known.
122 * {@code true} if this post is known, {@code false} otherwise
125 public Post setKnown(boolean known);
128 * Shell for a post that has not yet been loaded.
130 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
133 public static class EmptyPost implements Post {
135 private final String id;
137 public EmptyPost(String id) {
142 public String getId() {
147 public boolean isLoaded() {
152 public Sone getSone() {
157 public Optional<String> getRecipientId() {
162 public Optional<Sone> getRecipient() {
167 public long getTime() {
172 public String getText() {
177 public boolean isKnown() {
182 public Post setKnown(boolean known) {