2 * Sone - Post.java - Copyright © 2010–2020 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;
27 * A post is a short message that a user writes in his Sone to let other users
28 * know what is going on.
30 public interface Post extends Identified {
32 /** Comparator for posts, sorts descending by time. */
33 public static final Comparator<Post> NEWEST_FIRST = new Comparator<Post>() {
36 public int compare(Post leftPost, Post rightPost) {
37 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
47 * Returns the ID of the post.
49 * @return The ID of the post
51 public String getId();
54 * Returns whether this post has already been loaded.
56 * @return {@code true} if this post has already been loaded, {@code
62 * Returns the Sone this post belongs to.
64 * @return The Sone of this post
66 public Sone getSone();
69 * Returns the ID of the recipient {@link Sone}, or
70 * {@link Optional#absent()} if this post does not have a recipient.
72 * @return The ID of the recipient, or {@link Optional#absent()}
74 public Optional<String> getRecipientId();
77 * Returns the recipient of this post, if any.
79 * @return The recipient of this post, or {@link Optional#absent()} if there
82 public Optional<Sone> getRecipient();
85 * Returns the time of the post.
87 * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
89 public long getTime();
92 * Returns the text of the post.
94 * @return The text of the post
96 public String getText();
99 * Returns whether this post is known.
101 * @return {@code true} if this post is known, {@code false} otherwise
103 public boolean isKnown();
106 * Sets whether this post is known.
109 * {@code true} if this post is known, {@code false} otherwise
112 public Post setKnown(boolean known);
115 * Shell for a post that has not yet been loaded.
117 public static class EmptyPost implements Post {
119 private final String id;
121 public EmptyPost(String id) {
126 public String getId() {
131 public boolean isLoaded() {
136 public Sone getSone() {
141 public Optional<String> getRecipientId() {
146 public Optional<Sone> getRecipient() {
151 public long getTime() {
156 public String getText() {
161 public boolean isKnown() {
166 public Post setKnown(boolean known) {