2 * Sone - PostReplyBuilder.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.database;
20 import net.pterodactylus.sone.data.PostReply;
23 * Builder for a {@link PostReply} object.
25 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
27 public interface PostReplyBuilder extends ReplyBuilder<PostReplyBuilder> {
30 * Configures this builder to set the given post as post the created reply
34 * The ID of the post the reply refers to
35 * @return This builder
37 public PostReplyBuilder to(String postId);
40 * Verifies the configuration of this builder and creates a new post reply.
42 * The following conditions must be met in order for the configuration to be
45 * <li>Exactly one of {@link #randomId()} or {@link #withId(String)} must
46 * have been called.</li>
47 * <li>The {@link #from(String) sender} must not be {@code null}.</li>
48 * <li>Exactly one of {@link #currentTime()} or {@link #withTime(long)} must
49 * have been called.</li>
50 * <li>The {@link #withText(String) text} must not be {@code null} and must
51 * contain something other than whitespace.</li>
52 * <li>The {@link #to(String) post} have been set.</li>
55 * @return The created post reply
56 * @throws IllegalStateException
57 * if this builder’s configuration is not valid
59 public PostReply build() throws IllegalStateException;