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.data.Sone;
  22 import net.pterodactylus.sone.database.ImageBuilder;
  23
  24 /**
  25  * Abstract {@link ImageBuilder} 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 AbstractImageBuilder implements ImageBuilder {
  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         protected Sone sone;
  38         protected long creationTime;
  39         protected boolean createdNow;
  40         protected String key;
  41         protected int width;
  42         protected int height;
  43
  44         @Override
  45         public ImageBuilder randomId() {
  46                 randomId = true;
  47                 return this;
  48         }
  49
  50         @Override
  51         public ImageBuilder withId(String id) {
  52                 this.id = id;
  53                 return this;
  54         }
  55
  56         @Override
  57         public ImageBuilder by(Sone sone) {
  58                 this.sone = sone;
  59                 return this;
  60         }
  61
  62         @Override
  63         public ImageBuilder created(long creationTime) {
  64                 this.creationTime = creationTime;
  65                 return this;
  66         }
  67
  68         @Override
  69         public ImageBuilder createdNow() {
  70                 createdNow = true;
  71                 return this;
  72         }
  73
  74         @Override
  75         public ImageBuilder at(String key) {
  76                 this.key = key;
  77                 return this;
  78         }
  79
  80         @Override
  81         public ImageBuilder sized(int width, int height) {
  82                 this.width = width;
  83                 this.height = height;
  84                 return this;
  85         }
  86
  87         //
  88         // PROTECTED METHODS
  89         //
  90
  91         /**
  92          * Validates the state of this image builder.
  93          *
  94          * @throws IllegalStateException
  95          *              if the state is not valid for building a new image
  96          */
  97         protected void validate() throws IllegalStateException {
  98                 checkState((randomId && (id == null)) || (!randomId && (id != null)), "exactly one of random ID or custom ID must be set");
  99                 checkState(sone != null, "sone must not be null");
 100                 checkState((createdNow && (creationTime == 0)) || (!createdNow && (creationTime > 0)), "exactly one of created now or creation time must be set");
 101                 checkState((width > 0) && (height > 0), "width and height must be set");
 102         }
 103
 104 }