Turn post into an interface, add default implementation.

[Sone.git] / src / main / java / net / pterodactylus / sone / data / Post.java

diff --git a/src/main/java/net/pterodactylus/sone/data/Post.java b/src/main/java/net/pterodactylus/sone/data/Post.java
index 8c7ac51..f171475 100644 (file)
--- 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–2012 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,127 @@
 
 package net.pterodactylus.sone.data;
 
+import java.util.Comparator;
+
+import net.pterodactylus.util.collection.filter.Filter;
+
 /**
  * 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 class Post {
+public interface Post {
+
+       /** Comparator for posts, sorts descending by time. */
+       public static final Comparator<Post> TIME_COMPARATOR = new Comparator<Post>() {
+
+               @Override
+               public int compare(Post leftPost, Post rightPost) {
+                       return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
+               }
+
+       };
+
+       /** Filter for posts with timestamps from the future. */
+       public static final Filter<Post> FUTURE_POSTS_FILTER = new Filter<Post>() {
 
-       /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */
-       private final long time;
+               @Override
+               public boolean filterObject(Post post) {
+                       return post.getTime() <= System.currentTimeMillis();
+               }
 
-       /** The text of the post. */
-       private final String text;
+       };
+
+       //
+       // ACCESSORS
+       //
 
        /**
-        * Creates a new post.
+        * Returns the ID of the post.
         *
-        * @param time
-        *            The time of the post (in milliseconds since Jan 1, 1970 UTC)
-        * @param text
-        *            The text of the post
+        * @return The ID of the post
+        */
+       public String getId();
+
+       /**
+        * Returns the Sone this post belongs to.
+        *
+        * @return The Sone of this post
+        */
+       public Sone getSone();
+
+       /**
+        * Sets the Sone of this post.
+        *
+        * @param sone
+        *            The Sone of this post
+        * @return This post (for method chaining)
         */
-       public Post(long time, String text) {
-               this.time = time;
-               this.text = text;
-       }
+       public Post setSone(Sone sone);
+
+       /**
+        * Returns the recipient of this post, if any.
+        *
+        * @return The recipient of this post, or {@code null}
+        */
+       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);
 
        /**
         * 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();
+
+       /**
+        * 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
         */
-       public String text() {
-               return text;
-       }
+       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
+        */
+       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);
 
 }