Update year in copyright lines
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Post.java
index 6523e9b..b6648e2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - Post.java - Copyright © 2010–2013 David Roden
+ * Sone - Post.java - Copyright © 2010–2019 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,6 +17,8 @@
 
 package net.pterodactylus.sone.data;
 
+import static com.google.common.base.Optional.absent;
+
 import java.util.Comparator;
 
 import com.google.common.base.Optional;
@@ -25,13 +27,11 @@ import com.google.common.base.Predicate;
 /**
  * A post is a short message that a user writes in his Sone to let other users
  * know what is going on.
- *
- * @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>() {
+       public static final Comparator<Post> NEWEST_FIRST = new Comparator<Post>() {
 
                @Override
                public int compare(Post leftPost, Post rightPost) {
@@ -45,7 +45,7 @@ public interface Post {
 
                @Override
                public boolean apply(Post post) {
-                       return post.getTime() <= System.currentTimeMillis();
+                       return (post != null) && (post.getTime() <= System.currentTimeMillis());
                }
 
        };
@@ -62,6 +62,14 @@ public interface Post {
        public String getId();
 
        /**
+        * Returns whether this post has already been loaded.
+        *
+        * @return {@code true} if this post has already been loaded, {@code
+        * false} otherwise
+        */
+       boolean isLoaded();
+
+       /**
         * Returns the Sone this post belongs to.
         *
         * @return The Sone of this post
@@ -77,10 +85,7 @@ public interface Post {
        public Optional<String> getRecipientId();
 
        /**
-        * Returns the recipient of this post, if any. As this method can return
-        * {@link Optional#absent()} if the post has a recipient which has not yet
-        * been loaded, it is recommended to use {@link #hasRecipient()} to check
-        * for the presence of a recipient.
+        * Returns the recipient of this post, if any.
         *
         * @return The recipient of this post, or {@link Optional#absent()} if there
         *         is no recipient
@@ -117,4 +122,62 @@ public interface 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<String> getRecipientId() {
+                       return absent();
+               }
+
+               @Override
+               public Optional<Sone> 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;
+               }
+
+       }
+
 }