🔀 Merge branch 'release/v82'
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Reply.java
index 44aaf89..0cf2a52 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - Reply.java - Copyright Â© 2010 David Roden
+ * Sone - Reply.java - Copyright Â© 2010–2020 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.UUID;
-
 /**
- * A reply is like a {@link Post} but can never be posted on its own, it always
- * refers to another {@link Post}.
+ * Defines methods common for all replies.
  *
- * @author <a href="mailto:bombe@pterodactylus.net">David â€˜Bombe’ Roden</a>
+ * @param <T>
+ *            The type of the reply
  */
-public class Reply {
-
-       /** The Sone that posted this reply. */
-       private final Sone sone;
-
-       /** The ID of the reply. */
-       private final UUID id;
-
-       /** The Post this reply refers to. */
-       private final Post post;
-
-       /** The time of the reply. */
-       private final long time;
-
-       /** The text of the reply. */
-       private final String text;
-
-       /**
-        * Creates a new reply.
-        *
-        * @param sone
-        *            The sone that posted the reply
-        * @param post
-        *            The post to reply to
-        * @param text
-        *            The text of the reply
-        */
-       public Reply(Sone sone, Post post, String text) {
-               this(sone, post, System.currentTimeMillis(), text);
-       }
-
-       /**
-        * Creates a new reply-
-        *
-        * @param sone
-        *            The sone that posted the reply
-        * @param post
-        *            The post to reply to
-        * @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);
-       }
-
-       /**
-        * 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 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;
-               this.id = id;
-               this.post = post;
-               this.time = time;
-               this.text = text;
-       }
-
-       //
-       // ACCESSORS
-       //
-
-       /**
-        * Returns the Sone that posted this reply.
-        *
-        * @return The Sone that posted this reply
-        */
-       public Sone getSone() {
-               return sone;
-       }
+public interface Reply<T extends Reply<T>> extends Identified {
 
        /**
         * Returns the ID of the reply.
         *
         * @return The ID of the reply
         */
-       public String getId() {
-               return id.toString();
-       }
+       public String getId();
 
        /**
-        * Returns the post this reply refers to.
+        * Returns the Sone that posted this reply.
         *
-        * @return The post this reply refers to
+        * @return The Sone that posted this reply
         */
-       public Post getPost() {
-               return post;
-       }
+       public Sone getSone();
 
        /**
         * Returns the time of the reply.
         *
         * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
         */
-       public long getTime() {
-               return time;
-       }
+       public long getTime();
 
        /**
         * Returns the text of the reply.
         *
         * @return The text of the reply
         */
-       public String getText() {
-               return text;
-       }
-
-       //
-       // OBJECT METHODS
-       //
-
-       /**
-        * {@inheritDoc}
-        */
-       @Override
-       public int hashCode() {
-               return sone.hashCode() ^ id.hashCode() ^ post.hashCode() ^ (int) (time >> 32) ^ (int) (time & 0xffffffff);
-       }
+       public String getText();
 
        /**
-        * {@inheritDoc}
+        * Returns whether this reply is known.
+        *
+        * @return {@code true} if this reply is known, {@code false} otherwise
         */
-       @Override
-       public boolean equals(Object object) {
-               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);
-       }
+       public boolean isKnown();
 
 }