src/main/java/net/pterodactylus/sone/data/Reply.java

   1 /*
   2  * Sone - Reply.java - Copyright © 2010–2020 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.data;
  19
  20 /**
  21  * Defines methods common for all replies.
  22  *
  23  * @param <T>
  24  *            The type of the reply
  25  */
  26 public interface Reply<T extends Reply<T>> extends Identified {
  27
  28         /**
  29          * Returns the ID of the reply.
  30          *
  31          * @return The ID of the reply
  32          */
  33         public String getId();
  34
  35         /**
  36          * Returns the Sone that posted this reply.
  37          *
  38          * @return The Sone that posted this reply
  39          */
  40         public Sone getSone();
  41
  42         /**
  43          * Returns the time of the reply.
  44          *
  45          * @return The time of the reply (in milliseconds since Jan 1, 1970 UTC)
  46          */
  47         public long getTime();
  48
  49         /**
  50          * Returns the text of the reply.
  51          *
  52          * @return The text of the reply
  53          */
  54         public String getText();
  55
  56         /**
  57          * Returns whether this reply is known.
  58          *
  59          * @return {@code true} if this reply is known, {@code false} otherwise
  60          */
  61         public boolean isKnown();
  62
  63 }