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.Collections;
21 import java.util.Comparator;
22 import java.util.List;
25 import com.google.common.base.Function;
26 import com.google.common.base.Optional;
27 import com.google.common.base.Predicate;
30 * A post is a short message that a user writes in his Sone to let other users
31 * know what is going on.
33 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35 public interface Post extends Identified {
37 /** Comparator for posts, sorts descending by time. */
38 public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
41 public int compare(Post leftPost, Post rightPost) {
42 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
47 /** Filter for posts with timestamps from the future. */
48 public static final Predicate<Post> FUTURE_POSTS_FILTER = new Predicate<Post>() {
51 public boolean apply(Post post) {
52 return (post == null) ? false : post.getTime() <= System.currentTimeMillis();
57 public static final Function<Post, List<PostReply>> TO_REPLIES = new Function<Post, List<PostReply>>() {
59 public List<PostReply> apply(Post post) {
60 return (post == null) ? Collections.<PostReply>emptyList() : post.getReplies();
69 * Returns the ID of the post.
71 * @return The ID of the post
73 public String getId();
76 * Returns the Sone this post belongs to.
78 * @return The Sone of this post
80 public Sone getSone();
83 * Returns the ID of the recipient {@link Sone}, or
84 * {@link Optional#absent()} if this post does not have a recipient.
86 * @return The ID of the recipient, or {@link Optional#absent()}
88 public Optional<String> getRecipientId();
91 * Returns the recipient of this post, if any.
93 * @return The recipient of this post, or {@link Optional#absent()} if there
96 public Optional<Sone> getRecipient();
99 * Returns the time of the post.
101 * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
103 public long getTime();
106 * Returns the text of the post.
108 * @return The text of the post
110 public String getText();
113 * Returns whether this post is known.
115 * @return {@code true} if this post is known, {@code false} otherwise
117 public boolean isKnown();
120 * Sets whether this post is known.
123 * {@code true} if this post is known, {@code false} otherwise
126 public Post setKnown(boolean known);
128 public void like(Sone localSone);
129 public void unlike(Sone localSone);
131 Set<Sone> getLikes();
133 List<PostReply> getReplies();