X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FPost.java;h=d4d34e676cdaf12568366f898806b38e518cc7ff;hp=8c7ac51d486637c72d56e88f6ea2b037f1695377;hb=HEAD;hpb=e55884488ff905120dc9747b2dbb61319dca0274 diff --git a/src/main/java/net/pterodactylus/sone/data/Post.java b/src/main/java/net/pterodactylus/sone/data/Post.java index 8c7ac51..d4d34e6 100644 --- a/src/main/java/net/pterodactylus/sone/data/Post.java +++ b/src/main/java/net/pterodactylus/sone/data/Post.java @@ -1,5 +1,5 @@ /* - * FreenetSone - StatusUpdate.java - Copyright © 2010 David Roden + * Sone - Post.java - Copyright © 2010–2020 David Roden * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,49 +17,144 @@ package net.pterodactylus.sone.data; +import static com.google.common.base.Optional.absent; + +import com.google.common.base.Optional; + /** * A post is a short message that a user writes in his Sone to let other users * know what is going on. - * - * @author David ‘Bombe’ Roden */ -public class Post { +public interface Post extends Identified { - /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */ - private final long time; + // + // ACCESSORS + // - /** The text of the post. */ - private final String text; + /** + * Returns the ID of the post. + * + * @return The ID of the post + */ + public String getId(); /** - * Creates a new post. + * Returns whether this post has already been loaded. * - * @param time - * The time of the post (in milliseconds since Jan 1, 1970 UTC) - * @param text - * The text of the post + * @return {@code true} if this post has already been loaded, {@code + * false} otherwise */ - public Post(long time, String text) { - this.time = time; - this.text = text; - } + boolean isLoaded(); + + /** + * Returns the Sone this post belongs to. + * + * @return The Sone of this post + */ + public Sone getSone(); + + /** + * Returns the ID of the recipient {@link Sone}, or + * {@link Optional#absent()} if this post does not have a recipient. + * + * @return The ID of the recipient, or {@link Optional#absent()} + */ + public Optional getRecipientId(); + + /** + * Returns the recipient of this post, if any. + * + * @return The recipient of this post, or {@link Optional#absent()} if there + * is no recipient + */ + public Optional getRecipient(); /** * Returns the time of the post. * * @return The time of the post (in milliseconds since Jan 1, 1970 UTC) */ - public long time() { - return time; - } + public long getTime(); /** * Returns the text of the post. * * @return The text of the post */ - public String text() { - return text; + public String getText(); + + /** + * Returns whether this post is known. + * + * @return {@code true} if this post is known, {@code false} otherwise + */ + public boolean isKnown(); + + /** + * Sets whether this post is known. + * + * @param known + * {@code true} if this post is known, {@code false} otherwise + * @return This post + */ + public Post setKnown(boolean known); + + /** + * Shell for a post that has not yet been loaded. + */ + public static class EmptyPost implements Post { + + private final String id; + + public EmptyPost(String id) { + this.id = id; + } + + @Override + public String getId() { + return id; + } + + @Override + public boolean isLoaded() { + return false; + } + + @Override + public Sone getSone() { + return null; + } + + @Override + public Optional getRecipientId() { + return absent(); + } + + @Override + public Optional getRecipient() { + return absent(); + } + + @Override + public long getTime() { + return 0; + } + + @Override + public String getText() { + return null; + } + + @Override + public boolean isKnown() { + return false; + } + + @Override + public Post setKnown(boolean known) { + return this; + } + } }