Remove javadoc comments from overriding methods.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / impl / AbstractPostBuilder.java
1 /*
2  * Sone - AbstractPostBuilder.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.data.impl;
19
20 import static com.google.common.base.Optional.absent;
21 import static com.google.common.base.Optional.fromNullable;
22 import static com.google.common.base.Optional.of;
23 import static com.google.common.base.Preconditions.checkNotNull;
24 import static com.google.common.base.Preconditions.checkState;
25 import static java.lang.System.currentTimeMillis;
26 import static java.util.UUID.randomUUID;
27
28 import net.pterodactylus.sone.database.Database;
29 import net.pterodactylus.sone.database.PostBuilder;
30
31 import com.google.common.base.Optional;
32 import org.apache.commons.lang.StringUtils;
33
34 /**
35  * Abstract {@link PostBuilder} implementation. It stores the state of the new
36  * post and performs validation, you only need to implement {@link #build()}.
37  *
38  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
39  */
40 public abstract class AbstractPostBuilder implements PostBuilder {
41
42         protected final Database database;
43         protected final String senderId;
44
45         /** The ID of the post. */
46         protected Optional<String> id = absent();
47
48         /** The time of the post. */
49         protected Optional<Long> time = absent();
50
51         /** The text of the post. */
52         protected String text;
53
54         /** The (optional) recipient of the post. */
55         protected Optional<String> recipientId = absent();
56
57         protected AbstractPostBuilder(Database database, String soneId) {
58                 this.database = checkNotNull(database, "database must not be null");
59                 this.senderId = checkNotNull(soneId, "sender ID must not be null");
60         }
61
62         //
63         // POSTBUILDER METHODS
64         //
65
66         @Override
67         public PostBuilder withId(String id) {
68                 this.id = fromNullable(id);
69                 return this;
70         }
71
72         @Override
73         public PostBuilder withTime(long time) {
74                 this.time = of(time);
75                 return this;
76         }
77
78         @Override
79         public PostBuilder withText(String text) {
80                 this.text = text;
81                 return this;
82         }
83
84         @Override
85         public PostBuilder to(Optional<String> recipientId) {
86                 this.recipientId = recipientId;
87                 return this;
88         }
89
90         //
91         // PROTECTED METHODS
92         //
93
94         protected String getId() {
95                 return id.isPresent() ? id.get() : randomUUID().toString();
96         }
97
98         protected long getTime() {
99                 return time.isPresent() ? time.get() : currentTimeMillis();
100         }
101
102         /**
103          * Validates the state of this post builder.
104          *
105          * @throws IllegalStateException
106          *             if the state is not valid for building a new post
107          */
108         protected void validate() throws IllegalStateException {
109                 checkState(!StringUtils.isBlank(text), "text must not be empty");
110                 checkState(!recipientId.isPresent() || !senderId.equals(recipientId.get()), "sender and recipient must not be the same");
111         }
112
113 }