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