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 com.google.common.base.Optional;
25 * A post is a short message that a user writes in his Sone to let other users
26 * know what is going on.
28 public interface Post extends Identified {
35 * Returns the ID of the post.
37 * @return The ID of the post
39 public String getId();
42 * Returns whether this post has already been loaded.
44 * @return {@code true} if this post has already been loaded, {@code
50 * Returns the Sone this post belongs to.
52 * @return The Sone of this post
54 public Sone getSone();
57 * Returns the ID of the recipient {@link Sone}, or
58 * {@link Optional#absent()} if this post does not have a recipient.
60 * @return The ID of the recipient, or {@link Optional#absent()}
62 public Optional<String> getRecipientId();
65 * Returns the recipient of this post, if any.
67 * @return The recipient of this post, or {@link Optional#absent()} if there
70 public Optional<Sone> getRecipient();
73 * Returns the time of the post.
75 * @return The time of the post (in milliseconds since Jan 1, 1970 UTC)
77 public long getTime();
80 * Returns the text of the post.
82 * @return The text of the post
84 public String getText();
87 * Returns whether this post is known.
89 * @return {@code true} if this post is known, {@code false} otherwise
91 public boolean isKnown();
94 * Sets whether this post is known.
97 * {@code true} if this post is known, {@code false} otherwise
100 public Post setKnown(boolean known);
103 * Shell for a post that has not yet been loaded.
105 public static class EmptyPost implements Post {
107 private final String id;
109 public EmptyPost(String id) {
114 public String getId() {
119 public boolean isLoaded() {
124 public Sone getSone() {
129 public Optional<String> getRecipientId() {
134 public Optional<Sone> getRecipient() {
139 public long getTime() {
144 public String getText() {
149 public boolean isKnown() {
154 public Post setKnown(boolean known) {