2 * Sone - PostBuilder.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.Post;
21 import net.pterodactylus.sone.data.Sone;
24 * Builder for {@link Post} objects.
26 * A {@link Post} consists of the following elements:
29 * <li>a {@link Sone sender},</li>
30 * <li>an optional {@link Sone recipient},</li>
32 * <li>and a text.</li>
34 * Except for the recipient, all this elements have to be configured on this
35 * builder. For the ID you have the possibility to configure either a random ID
36 * (which should be used for new posts) or a custom ID you specify (for creating
37 * an existing post). For the time you can use the current time (again, for
38 * creating new posts) or the given time (for loading posts). It is an error to
39 * specify both ways for either the ID or the time.
41 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
43 public interface PostBuilder {
46 * Configures this builder to use a random ID for the new post. If this
47 * method is used, {@link #withId(String)} must not be used.
49 * @return This post builder
51 public PostBuilder randomId();
54 * Configures this builder to use the given ID as ID for the new post. If
55 * this method is used, {@link #randomId()} must not be used.
58 * The ID to use for the post
59 * @return This post builder
61 public PostBuilder withId(String id);
64 * Configures this builder to use the current time when creating the post.
65 * If this method is used, {@link #withTime(long)} must not be used.
67 * @return This post builder
69 public PostBuilder currentTime();
72 * Configures the builder to use the given time as time for the new post. If
73 * this method is used, {@link #currentTime()} must not be used.
76 * The time to use for the post
77 * @return This post builder
79 public PostBuilder withTime(long time);
82 * Configures the builder to use the given text for the new post.
85 * The text to use for the post
86 * @return This post builder
88 public PostBuilder withText(String text);
91 * Configures the builder to use the given {@link Sone} as recipient for the
95 * The ID of the recipient of the post
96 * @return This post builder
98 public PostBuilder to(String recipientId);
101 * Verifies this builder’s configuration and creates a new post.
103 * The following conditions must be met in order for this builder to be
104 * configured correctly:
106 * <li>Exactly one of {@link #randomId()} or {@link #withId(String)} must
107 * have been called.</li>
108 * <li>The {@link #from(String) sender} must not be {@code null}.</li>
109 * <li>Exactly one of {@link #currentTime()} or {@link #withTime(long)} must
110 * have been called.</li>
111 * <li>The {@link #withText(String) text} must not be {@code null} and must
112 * contain something other than whitespace.</li>
113 * <li>The {@link #to(String) recipient} must either not have been set, or
114 * it must have been set to a {@link Sone} other than {@link #from(String)
119 * @throws IllegalStateException
120 * if this builder’s configuration is not valid
122 public Post build() throws IllegalStateException;