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 import static java.util.UUID.randomUUID;
  21
  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 long creationTime;
  38         protected boolean createdNow;
  39         protected String key;
  40         protected int width;
  41         protected int height;
  42
  43         @Override
  44         public ImageBuilder randomId() {
  45                 randomId = true;
  46                 return this;
  47         }
  48
  49         @Override
  50         public ImageBuilder withId(String id) {
  51                 this.id = id;
  52                 return this;
  53         }
  54
  55         @Override
  56         public ImageBuilder created(long creationTime) {
  57                 this.creationTime = creationTime;
  58                 return this;
  59         }
  60
  61         @Override
  62         public ImageBuilder createdNow() {
  63                 createdNow = true;
  64                 return this;
  65         }
  66
  67         @Override
  68         public ImageBuilder at(String key) {
  69                 this.key = key;
  70                 return this;
  71         }
  72
  73         @Override
  74         public ImageBuilder sized(int width, int height) {
  75                 this.width = width;
  76                 this.height = height;
  77                 return this;
  78         }
  79
  80         //
  81         // PROTECTED METHODS
  82         //
  83
  84         protected String getId() {
  85                 return randomId ? randomUUID().toString() : id;
  86         }
  87
  88         protected long getCreationTime() {
  89                 return createdNow ? System.currentTimeMillis() : creationTime;
  90         }
  91
  92         /**
  93          * Validates the state of this image builder.
  94          *
  95          * @throws IllegalStateException
  96          *              if the state is not valid for building a new image
  97          */
  98         protected void validate() throws IllegalStateException {
  99                 checkState((randomId && (id == null)) || (!randomId && (id != null)), "exactly one of random ID or custom ID must be set");
 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 }