src/main/java/net/pterodactylus/sone/database/ReplyBuilder.java

   1 /*
   2  * Sone - ReplyBuilder.java - Copyright © 2013 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.database;
  19
  20 import net.pterodactylus.sone.data.Reply;
  21 import net.pterodactylus.sone.data.Sone;
  22
  23 /**
  24  * Methods that all reply builders need to implement in order to be able to
  25  * create any kind of {@link Reply}.
  26  *
  27  * @param <B>
  28  *            The type of the builder
  29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  30  */
  31 public interface ReplyBuilder<B extends ReplyBuilder<B>> {
  32
  33         /**
  34          * Configures this builder to use the given ID when creating the reply. If
  35          * this method is used, {@link #randomId()} must not be used.
  36          *
  37          * @param id
  38          *            The ID of the reply
  39          * @return This builder
  40          */
  41         public B withId(String id);
  42
  43         /**
  44          * Configures this builder to use the ID of the given {@link Sone} as sender
  45          * of the reply.
  46          *
  47          * @param senderId
  48          *            The ID of the sender of the reply
  49          * @return This builder
  50          */
  51         public B from(String senderId);
  52
  53         /**
  54          * Configures this builder to use the given time when creating the reply. If
  55          * this method is used, {@link #currentTime()} must not be used.
  56          *
  57          * @param time
  58          *            The time of the reply
  59          * @return This builder
  60          */
  61         public B withTime(long time);
  62
  63         /**
  64          * Configures this builder to use the given text when creating the reply.
  65          *
  66          * @param text
  67          *            The text of the reply
  68          * @return This builder
  69          */
  70         public B withText(String text);
  71
  72 }