Move reply like functionality from Sone to Reply.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Reply.java
index 935c79b..510b81f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - Reply.java - Copyright © 2011 David Roden
+ * Sone - Reply.java - Copyright © 2010–2013 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.Set;
 
-import net.pterodactylus.util.filter.Filter;
+import com.google.common.base.Optional;
+import com.google.common.base.Predicate;
 
 /**
- * Abstract base class for all replies.
+ * Defines methods common for all replies.
  *
  * @param <T>
  *            The type of the reply
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public abstract class Reply<T extends Reply<T>> {
+public interface Reply<T extends Reply<T>> extends Identified {
 
        /** Comparator that sorts replies ascending by time. */
-       public static final Comparator<Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
+       public static final Comparator<? super Reply<?>> TIME_COMPARATOR = new Comparator<Reply<?>>() {
 
                /**
                 * {@inheritDoc}
@@ -44,14 +46,14 @@ public abstract class Reply<T extends Reply<T>> {
        };
 
        /** Filter for replies with timestamps from the future. */
-       public static final Filter<Reply<?>> FUTURE_REPLY_FILTER = new Filter<Reply<?>>() {
+       public static final Predicate<Reply<?>> FUTURE_REPLY_FILTER = new Predicate<Reply<?>>() {
 
                /**
                 * {@inheritDoc}
                 */
                @Override
-               public boolean filterObject(Reply<?> reply) {
-                       return reply.getTime() <= System.currentTimeMillis();
+               public boolean apply(Reply<?> reply) {
+                       return (reply == null) ? false : reply.getTime() <= System.currentTimeMillis();
                }
 
        };
@@ -61,27 +63,55 @@ public abstract class Reply<T extends Reply<T>> {
         *
         * @return The ID of the reply
         */
-       public abstract String getId();
+       public String getId();
 
        /**
         * Returns the Sone that posted this reply.
         *
         * @return The Sone that posted this reply
         */
-       public abstract Sone getSone();
+       public Sone getSone();
 
        /**
         * Returns the time of the reply.
         *
         * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
         */
-       public abstract long getTime();
+       public long getTime();
 
        /**
         * Returns the text of the reply.
         *
         * @return The text of the reply
         */
-       public abstract String getText();
+       public String getText();
+
+       /**
+        * Returns whether this reply is known.
+        *
+        * @return {@code true} if this reply is known, {@code false} otherwise
+        */
+       public boolean isKnown();
+
+       void like(Sone localSone);
+       void unlike(Sone localSone);
+
+       boolean isLiked(Sone sone);
+       Set<Sone> getLikes();
+
+       Modifier<T> modify();
+
+       interface Modifier<T> {
+
+               Modifier<T> setKnown();
+               T update(Optional<ReplyUpdated<T>> replyUpdated);
+
+               interface ReplyUpdated<T> {
+
+                       void replyUpdated(T reply);
+
+               }
+
+       }
 
 }