Remove post management methods from Sone.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / impl / AbstractImageBuilder.java
1 /*
2  * Sone - AbstractImageBuilder.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 package net.pterodactylus.sone.data.impl;
18
19 import static com.google.common.base.Preconditions.checkState;
20
21 import net.pterodactylus.sone.database.ImageBuilder;
22
23 /**
24  * Abstract {@link ImageBuilder} implementation. It stores the state of the new
25  * album and performs validation, you only need to implement {@link #build()}.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public abstract class AbstractImageBuilder implements ImageBuilder {
30
31         /** Whether to create an album with a random ID. */
32         protected boolean randomId;
33
34         /** The ID of the album to create. */
35         protected String id;
36
37         @Override
38         public ImageBuilder randomId() {
39                 randomId = true;
40                 return this;
41         }
42
43         @Override
44         public ImageBuilder withId(String id) {
45                 this.id = id;
46                 return this;
47         }
48
49         //
50         // PROTECTED METHODS
51         //
52
53         /**
54          * Validates the state of this image builder.
55          *
56          * @throws IllegalStateException
57          *              if the state is not valid for building a new image
58          */
59         protected void validate() throws IllegalStateException {
60                 checkState((randomId && (id == null)) || (!randomId && (id != null)), "exactly one of random ID or custom ID must be set");
61         }
62
63 }