2 * Sone - PostBuilder.java - Copyright © 2013–2016 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 * Copies all attributes of the given post to this post builder.
49 * The post whose attributes to copy into this builder
50 * @return This builder
51 * @throws NullPointerException
52 * if {@code post} is {@code null}
54 public PostBuilder copyPost(Post post) throws NullPointerException;
57 * Configures this builder to use the given Sone as sender of the new post.
60 * The ID of the sender of the post
61 * @return This post builder
63 public PostBuilder from(String senderId);
66 * Configures this builder to use a random ID for the new post. If this
67 * method is used, {@link #withId(String)} must not be used.
69 * @return This post builder
71 public PostBuilder randomId();
74 * Configures this builder to use the given ID as ID for the new post. If
75 * this method is used, {@link #randomId()} must not be used.
78 * The ID to use for the post
79 * @return This post builder
81 public PostBuilder withId(String id);
84 * Configures this builder to use the current time when creating the post.
85 * If this method is used, {@link #withTime(long)} must not be used.
87 * @return This post builder
89 public PostBuilder currentTime();
92 * Configures the builder to use the given time as time for the new post. If
93 * this method is used, {@link #currentTime()} must not be used.
96 * The time to use for the post
97 * @return This post builder
99 public PostBuilder withTime(long time);
102 * Configures the builder to use the given text for the new post.
105 * The text to use for the post
106 * @return This post builder
108 public PostBuilder withText(String text);
111 * Configures the builder to use the given {@link Sone} as recipient for the
115 * The ID of the recipient of the post
116 * @return This post builder
118 public PostBuilder to(String recipientId);
121 * Verifies this builder’s configuration and creates a new post.
123 * The following conditions must be met in order for this builder to be
124 * configured correctly:
126 * <li>Exactly one of {@link #randomId()} or {@link #withId(String)} must
127 * have been called.</li>
128 * <li>The {@link #from(String) sender} must not be {@code null}.</li>
129 * <li>Exactly one of {@link #currentTime()} or {@link #withTime(long)} must
130 * have been called.</li>
131 * <li>The {@link #withText(String) text} must not be {@code null} and must
132 * contain something other than whitespace.</li>
133 * <li>The {@link #to(String) recipient} must either not have been set, or
134 * it must have been set to a {@link Sone} other than {@link #from(String)
139 * @throws IllegalStateException
140 * if this builder’s configuration is not valid
142 public Post build() throws IllegalStateException;