2 * Sone - ReplyBuilder.java - Copyright © 2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.data;
21 * Methods that all reply builders need to implement in order to be able to
22 * create any kind of {@link Reply}.
25 * The type of the builder
26 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28 public interface ReplyBuilder<B extends ReplyBuilder<B>> {
31 * Configures this builder to use a random ID when creating the reply. If
32 * this method is used, {@link #withId(String)} must not be used.
34 * @return This builder
39 * Configures this builder to use the given ID when creating the reply. If
40 * this method is used, {@link #randomId()} must not be used.
44 * @return This builder
46 public B withId(String id);
49 * Configures this builder to use the ID of the given {@link Sone} as sender
53 * The ID of the sender of the reply
54 * @return This builder
56 public B from(String senderId);
59 * Configures this builder to use the current time when creating the reply.
60 * If this method is used, {@link #withTime(long)} must not be used.
62 * @return This builder
64 public B currentTime();
67 * Configures this builder to use the given time when creating the reply. If
68 * this method is used, {@link #currentTime()} must not be used.
71 * The time of the reply
72 * @return This builder
74 public B withTime(long time);
77 * Configures this builder to use the given text when creating the reply.
80 * The text of the reply
81 * @return This builder
83 public B withText(String text);