Change all copyright headers to include 2012.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Reply.java
index 44aaf89..6d0cbdb 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - Reply.java - Copyright © 2010 David Roden
+ * Sone - Reply.java - Copyright © 2011–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 reply is like a {@link Post} but can never be posted on its own, it always
- * refers to another {@link Post}.
+ * Abstract base class for all replies.
  *
+ * @param <T>
+ *            The type of the reply
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Reply {
+public abstract class Reply<T extends Reply<T>> {
+
+       /** Comparator that sorts replies ascending by time. */
+       public static final Comparator<Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public int compare(Reply<?> leftReply, Reply<?> rightReply) {
+                       return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
+               }
+
+       };
 
-       /** The Sone that posted this reply. */
-       private final Sone sone;
+       /** Filter for replies with timestamps from the future. */
+       public static final Filter<Reply<?>> FUTURE_REPLY_FILTER = new Filter<Reply<?>>() {
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public boolean filterObject(Reply<?> reply) {
+                       return reply.getTime() <= System.currentTimeMillis();
+               }
+
+       };
 
        /** The ID of the reply. */
-       private final UUID id;
+       private final String id;
 
-       /** The Post this reply refers to. */
-       private final Post post;
+       /** The Sone that created this reply. */
+       private volatile Sone sone;
 
        /** The time of the reply. */
-       private final long time;
+       private volatile long time;
 
        /** The text of the reply. */
-       private final String text;
+       private volatile String text;
+
+       /** Whether the reply is known. */
+       private volatile boolean known;
 
        /**
-        * Creates a new reply.
+        * Creates a new reply with the given ID.
         *
-        * @param sone
-        *            The sone that posted the reply
-        * @param post
-        *            The post to reply to
-        * @param text
-        *            The text of the reply
+        * @param id
+        *            The ID of the reply
         */
-       public Reply(Sone sone, Post post, String text) {
-               this(sone, post, System.currentTimeMillis(), text);
+       protected Reply(String id) {
+               this(id, null, 0, null);
        }
 
        /**
-        * Creates a new reply-
+        * Creates a new reply with a new random ID.
         *
         * @param sone
-        *            The sone that posted the reply
-        * @param post
-        *            The post to reply to
+        *            The Sone of the reply
         * @param time
         *            The time of the reply
         * @param text
         *            The text of the reply
         */
-       public Reply(Sone sone, Post post, long time, String text) {
-               this(sone, UUID.randomUUID(), post, time, text);
+       protected Reply(Sone sone, long time, String text) {
+               this(UUID.randomUUID().toString(), sone, time, text);
        }
 
        /**
-        * Creates a new reply-
+        * Creates a new reply.
         *
-        * @param sone
-        *            The sone that posted the reply
         * @param id
         *            The ID of the reply
-        * @param post
-        *            The post to reply to
+        * @param sone
+        *            The Sone of the reply
         * @param time
         *            The time of the reply
         * @param text
         *            The text of the reply
         */
-       public Reply(Sone sone, UUID id, Post post, long time, String text) {
-               this.sone = sone;
+       protected Reply(String id, Sone sone, long time, String text) {
                this.id = id;
-               this.post = post;
+               this.sone = sone;
                this.time = time;
                this.text = text;
        }
 
-       //
-       // ACCESSORS
-       //
+       /**
+        * Returns the ID of the reply.
+        *
+        * @return The ID of the reply
+        */
+       public String getId() {
+               return id;
+       }
 
        /**
         * Returns the Sone that posted this reply.
@@ -108,30 +134,38 @@ public class Reply {
        }
 
        /**
-        * Returns the ID of the reply.
+        * Sets the Sone that posted this reply.
         *
-        * @return The ID of the reply
+        * @param sone
+        *            The Sone that posted this reply
+        * @return This reply (for method chaining)
         */
-       public String getId() {
-               return id.toString();
+       @SuppressWarnings("unchecked")
+       public T setSone(Sone sone) {
+               this.sone = sone;
+               return (T) this;
        }
 
        /**
-        * Returns the post this reply refers to.
+        * Returns the time of the reply.
         *
-        * @return The post this reply refers to
+        * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
         */
-       public Post getPost() {
-               return post;
+       public long getTime() {
+               return time;
        }
 
        /**
-        * Returns the time of the reply.
+        * Sets the time of this reply.
         *
-        * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
+        * @param time
+        *            The time of this reply (in milliseconds since Jan 1, 1970 UTC)
+        * @return This reply (for method chaining)
         */
-       public long getTime() {
-               return time;
+       @SuppressWarnings("unchecked")
+       public T setTime(long time) {
+               this.time = time;
+               return (T) this;
        }
 
        /**
@@ -143,6 +177,41 @@ public class Reply {
                return text;
        }
 
+       /**
+        * Sets the text of this reply.
+        *
+        * @param text
+        *            The text of this reply
+        * @return This reply (for method chaining)
+        */
+       @SuppressWarnings("unchecked")
+       public T setText(String text) {
+               this.text = text;
+               return (T) this;
+       }
+
+       /**
+        * Returns whether this reply is known.
+        *
+        * @return {@code true} if this reply is known, {@code false} otherwise
+        */
+       public boolean isKnown() {
+               return known;
+       }
+
+       /**
+        * Sets whether this reply is known.
+        *
+        * @param known
+        *            {@code true} if this reply is known, {@code false} otherwise
+        * @return This reply
+        */
+       @SuppressWarnings("unchecked")
+       public T setKnown(boolean known) {
+               this.known = known;
+               return (T) this;
+       }
+
        //
        // OBJECT METHODS
        //
@@ -152,7 +221,7 @@ public class Reply {
         */
        @Override
        public int hashCode() {
-               return sone.hashCode() ^ id.hashCode() ^ post.hashCode() ^ (int) (time >> 32) ^ (int) (time & 0xffffffff);
+               return id.hashCode();
        }
 
        /**
@@ -160,11 +229,19 @@ public class Reply {
         */
        @Override
        public boolean equals(Object object) {
-               if (!(object instanceof Reply)) {
+               if (!(object instanceof Reply<?>)) {
                        return false;
                }
-               Reply reply = (Reply) object;
-               return reply.sone.equals(sone) && reply.id.equals(id) && reply.post.equals(post) && (reply.time == time) && reply.text.equals(text);
+               Reply<?> reply = (Reply<?>) object;
+               return reply.id.equals(id);
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public String toString() {
+               return getClass().getName() + "[id=" + id + ",sone=" + sone + ",time=" + time + ",text=" + text + "]";
        }
 
 }