Extract memory-backed post database into its own class.
[Sone.git] / src / main / java / net / pterodactylus / sone / database / PostReplyBuilder.java
1 /*
2  * Sone - PostReplyBuilder.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.PostReply;
21
22 import com.google.common.base.Optional;
23
24 /**
25  * Builder for a {@link PostReply} object.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public interface PostReplyBuilder extends ReplyBuilder<PostReplyBuilder> {
30
31         /**
32          * Verifies the configuration of this builder and creates a new post reply.
33          * <p>
34          * The following conditions must be met in order for the configuration to be
35          * considered valid:
36          * <ul>
37          * <li>Exactly one of {@link #randomId()} or {@link #withId(String)} must
38          * have been called.</li>
39          * <li>The {@link #from(String) sender} must not be {@code null}.</li>
40          * <li>Exactly one of {@link #currentTime()} or {@link #withTime(long)} must
41          * have been called.</li>
42          * <li>The {@link #withText(String) text} must not be {@code null} and must
43          * contain something other than whitespace.</li>
44          * <li>The {@link #to(String) post} have been set.</li>
45          * </ul>
46          *
47          * @return The created post reply
48          * @throws IllegalStateException
49          *             if this builder’s configuration is not valid
50          */
51         public PostReply build(Optional<PostReplyCreated> postReplyCreated) throws IllegalStateException;
52
53         interface PostReplyCreated {
54
55                 void postReplyCreated(PostReply postReply);
56
57         }
58
59 }