src/main/java/net/pterodactylus/sone/data/impl/AbstractAlbumBuilder.java

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