Change all copyright headers to include 2012.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Post.java
index 9cf986f..24bcf8c 100644 (file)
@@ -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
 
 package net.pterodactylus.sone.data;
 
+import java.util.Comparator;
+import java.util.UUID;
+
+import net.pterodactylus.util.filter.Filter;
+
 /**
  * A post is a short message that a user writes in his Sone to let other users
  * know what is going on.
@@ -25,25 +30,156 @@ package net.pterodactylus.sone.data;
  */
 public class 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>() {
+
+               @Override
+               public boolean filterObject(Post post) {
+                       return post.getTime() <= System.currentTimeMillis();
+               }
+
+       };
+
+       /** The GUID of the post. */
+       private final UUID id;
+
+       /** The Sone this post belongs to. */
+       private volatile Sone sone;
+
+       /** The Sone of the recipient. */
+       private volatile Sone recipient;
+
        /** The time of the post (in milliseconds since Jan 1, 1970 UTC). */
-       private final long time;
+       private volatile long time;
 
        /** The text of the post. */
-       private final String text;
+       private volatile String text;
+
+       /** Whether the post is known. */
+       private volatile boolean known;
+
+       /**
+        * Creates a new post.
+        *
+        * @param id
+        *            The ID of the post
+        */
+       public Post(String id) {
+               this(id, null, 0, null);
+       }
+
+       /**
+        * Creates a new post.
+        *
+        * @param sone
+        *            The Sone this post belongs to
+        * @param text
+        *            The text of the post
+        */
+       public Post(Sone sone, String text) {
+               this(sone, System.currentTimeMillis(), text);
+       }
 
        /**
         * Creates a new post.
         *
+        * @param sone
+        *            The Sone this post belongs to
         * @param time
         *            The time of the post (in milliseconds since Jan 1, 1970 UTC)
         * @param text
         *            The text of the post
         */
-       public Post(long time, String text) {
+       public Post(Sone sone, long time, String text) {
+               this(UUID.randomUUID().toString(), sone, time, text);
+       }
+
+       /**
+        * Creates a new post.
+        *
+        * @param id
+        *            The ID of the post
+        * @param sone
+        *            The Sone this post belongs to
+        * @param time
+        *            The time of the post (in milliseconds since Jan 1, 1970 UTC)
+        * @param text
+        *            The text of the post
+        */
+       public Post(String id, Sone sone, long time, String text) {
+               this.id = UUID.fromString(id);
+               this.sone = sone;
                this.time = time;
                this.text = text;
        }
 
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns the ID of the post.
+        *
+        * @return The ID of the post
+        */
+       public String getId() {
+               return id.toString();
+       }
+
+       /**
+        * Returns the Sone this post belongs to.
+        *
+        * @return The Sone of this post
+        */
+       public Sone getSone() {
+               return sone;
+       }
+
+       /**
+        * Sets the Sone of this post.
+        *
+        * @param sone
+        *            The Sone of this post
+        * @return This post (for method chaining)
+        */
+       public Post setSone(Sone sone) {
+               this.sone = sone;
+               return this;
+       }
+
+       /**
+        * Returns the recipient of this post, if any.
+        *
+        * @return The recipient of this post, or {@code null}
+        */
+       public Sone getRecipient() {
+               return recipient;
+       }
+
+       /**
+        * 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) {
+               if (!sone.equals(recipient)) {
+                       this.recipient = recipient;
+               }
+               return this;
+       }
+
        /**
         * Returns the time of the post.
         *
@@ -54,6 +190,18 @@ public class Post {
        }
 
        /**
+        * 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) {
+               this.time = time;
+               return this;
+       }
+
+       /**
         * Returns the text of the post.
         *
         * @return The text of the post
@@ -62,4 +210,69 @@ public class Post {
                return text;
        }
 
+       /**
+        * Sets the text of this post.
+        *
+        * @param text
+        *            The text of this post
+        * @return This post (for method chaining)
+        */
+       public Post setText(String text) {
+               this.text = text;
+               return this;
+       }
+
+       /**
+        * Returns whether this post is known.
+        *
+        * @return {@code true} if this post is known, {@code false} otherwise
+        */
+       public boolean isKnown() {
+               return known;
+       }
+
+       /**
+        * 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) {
+               this.known = known;
+               return this;
+       }
+
+       //
+       // OBJECT METHODS
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public int hashCode() {
+               return id.hashCode();
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public boolean equals(Object object) {
+               if (!(object instanceof Post)) {
+                       return false;
+               }
+               Post post = (Post) object;
+               return post.id.equals(id);
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public String toString() {
+               return getClass().getName() + "[id=" + id + ",sone=" + sone + ",time=" + time + ",text=" + text + "]";
+       }
+
 }