Add unit test for delete profile field page
[Sone.git] / src / main / java / net / pterodactylus / sone / data / impl / AbstractAlbumBuilder.java
1 /*
2  * Sone - AbstractAlbumBuilder.java - Copyright © 2013–2016 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.Preconditions.checkState;
21
22 import net.pterodactylus.sone.data.Sone;
23 import net.pterodactylus.sone.database.AlbumBuilder;
24
25 /**
26  * Abstract {@link AlbumBuilder} implementation. It stores the state of the new
27  * album and performs validation, you only need to implement {@link #build()}.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public abstract class AbstractAlbumBuilder implements AlbumBuilder {
32
33         /** Whether to create an album with a random ID. */
34         protected boolean randomId;
35
36         /** The ID of the album to create. */
37         protected String id;
38         protected Sone sone;
39
40         @Override
41         public AlbumBuilder randomId() {
42                 randomId = true;
43                 return this;
44         }
45
46         @Override
47         public AlbumBuilder withId(String id) {
48                 this.id = id;
49                 return this;
50         }
51
52         public AlbumBuilder by(Sone sone) {
53                 this.sone = sone;
54                 return this;
55         }
56
57         //
58         // PROTECTED METHODS
59         //
60
61         /**
62          * Validates the state of this post builder.
63          *
64          * @throws IllegalStateException
65          *              if the state is not valid for building a new post
66          */
67         protected void validate() throws IllegalStateException {
68                 checkState((randomId && (id == null)) || (!randomId && (id != null)), "exactly one of random ID or custom ID must be set");
69                 checkState(sone != null, "Sone must not be null");
70         }
71
72 }