2 * Sone - Post.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.Optional;
23 import com.google.common.base.Predicate;
26 * A post is a short message that a user writes in his Sone to let other users
27 * know what is going on.
29 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
31 public interface Post extends Identified {
33 /** Comparator for posts, sorts descending by time. */
34 public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
37 public int compare(Post leftPost, Post rightPost) {
38 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
43 /** Filter for posts with timestamps from the future. */
44 public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
47 public boolean apply(Post post) {
48 return (post != null) && (post.getTime() <= System.currentTimeMillis());
58 * Returns the ID of the post.
60 * @return The ID of the post
62 public String getId();
65 * Returns the Sone this post belongs to.
67 * @return The Sone of this post
69 public Sone getSone();
72 * Returns the ID of the recipient {@link Sone}, or
73 * {@link Optional#absent()} if this post does not have a recipient.
75 * @return The ID of the recipient, or {@link Optional#absent()}
77 public Optional<String> getRecipientId();
80 * Returns the recipient of this post, if any.
82 * @return The recipient of this post, or {@link Optional#absent()} if there
85 public Optional<Sone> getRecipient();
88 * Returns the time of the post.
90 * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
92 public long getTime();
95 * Returns the text of the post.
97 * @return The text of the post
99 public String getText();
102 * Returns whether this post is known.
104 * @return {@code true} if this post is known, {@code false} otherwise
106 public boolean isKnown();
109 * Sets whether this post is known.
112 * {@code true} if this post is known, {@code false} otherwise
115 public Post setKnown(boolean known);