Trim field name before using it.
[Sone.git] / 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 a random ID when creating the reply. If
35          * this method is used, {@link #withId(String)} must not be used.
36          *
37          * @return This builder
38          */
39         public B randomId();
40
41         /**
42          * Configures this builder to use the given ID when creating the reply. If
43          * this method is used, {@link #randomId()} must not be used.
44          *
45          * @param id
46          *            The ID of the reply
47          * @return This builder
48          */
49         public B withId(String id);
50
51         /**
52          * Configures this builder to use the ID of the given {@link Sone} as sender
53          * of the reply.
54          *
55          * @param senderId
56          *            The ID of the sender of the reply
57          * @return This builder
58          */
59         public B from(String senderId);
60
61         /**
62          * Configures this builder to use the current time when creating the reply.
63          * If this method is used, {@link #withTime(long)} must not be used.
64          *
65          * @return This builder
66          */
67         public B currentTime();
68
69         /**
70          * Configures this builder to use the given time when creating the reply. If
71          * this method is used, {@link #currentTime()} must not be used.
72          *
73          * @param time
74          *            The time of the reply
75          * @return This builder
76          */
77         public B withTime(long time);
78
79         /**
80          * Configures this builder to use the given text when creating the reply.
81          *
82          * @param text
83          *            The text of the reply
84          * @return This builder
85          */
86         public B withText(String text);
87
88 }