Fix javadoc.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Post.java
index 3486bed..2524207 100644 (file)
@@ -19,6 +19,7 @@ package net.pterodactylus.sone.data;
 
 import java.util.Comparator;
 
+import com.google.common.base.Optional;
 import com.google.common.base.Predicate;
 
 /**
@@ -27,7 +28,7 @@ import com.google.common.base.Predicate;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public interface Post {
+public interface Post extends Identified {
 
        /** Comparator for posts, sorts descending by time. */
        public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
@@ -68,29 +69,20 @@ public interface Post {
        public Sone getSone();
 
        /**
-        * Sets the Sone of this post.
+        * Returns the ID of the recipient {@link Sone}, or
+        * {@link Optional#absent()} if this post does not have a recipient.
         *
-        * @param sone
-        *            The Sone of this post
-        * @return This post (for method chaining)
+        * @return The ID of the recipient, or {@link Optional#absent()}
         */
-       public Post setSone(Sone sone);
+       public Optional<String> getRecipientId();
 
        /**
         * Returns the recipient of this post, if any.
         *
-        * @return The recipient of this post, or {@code null}
+        * @return The recipient of this post, or {@link Optional#absent()} if there
+        *         is no recipient
         */
-       public Sone getRecipient();
-
-       /**
-        * Sets the recipient of this post.
-        *
-        * @param recipient
-        *            The recipient of this post, or {@code null}
-        * @return This post (for method chaining)
-        */
-       public Post setRecipient(Sone recipient);
+       public Optional<Sone> getRecipient();
 
        /**
         * Returns the time of the post.
@@ -100,15 +92,6 @@ public interface Post {
        public long getTime();
 
        /**
-        * Sets the time of this post.
-        *
-        * @param time
-        *            The time of this post (in milliseconds since Jan 1, 1970 UTC)
-        * @return This post (for method chaining)
-        */
-       public Post setTime(long time);
-
-       /**
         * Returns the text of the post.
         *
         * @return The text of the post
@@ -116,15 +99,6 @@ public interface Post {
        public String getText();
 
        /**
-        * Sets the text of this post.
-        *
-        * @param text
-        *            The text of this post
-        * @return This post (for method chaining)
-        */
-       public Post setText(String text);
-
-       /**
         * Returns whether this post is known.
         *
         * @return {@code true} if this post is known, {@code false} otherwise