java/src/main/com/google/appengine/api/images/ServingUrlOptions.java

   1 // Copyright 2012 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.images;
   4
   5 import com.google.appengine.api.blobstore.BlobKey;
   6 import static com.google.appengine.api.images.ImagesService.SERVING_SIZES_LIMIT;
   7
   8 /**
   9  * Allow users to customize the behavior of creating a image serving URL using
  10  * the {@link ImagesService}.
  11  *
  12  */
  13 public final class ServingUrlOptions {
  14
  15   private BlobKey blobKey;
  16
  17   private Boolean secureUrl;
  18
  19   private Integer imageSize;
  20
  21   private Boolean crop;
  22
  23   private String googleStorageFileName;
  24
  25   private ServingUrlOptions() {
  26   }
  27
  28   public ServingUrlOptions blobKey(BlobKey blobKey) {
  29     if (googleStorageFileName != null) {
  30       throw new IllegalArgumentException("Cannot specify both a blobKey and a " +
  31           "googleStorageFileName.");
  32     }
  33     this.blobKey = blobKey;
  34     return this;
  35   }
  36
  37   boolean hasBlobKey() {
  38     return blobKey != null;
  39   }
  40
  41   BlobKey getBlobKey() {
  42     if (blobKey == null) {
  43       throw new IllegalStateException("blobKey has not been set.");
  44     }
  45     return blobKey;
  46   }
  47
  48   public ServingUrlOptions googleStorageFileName(String fileName) {
  49     if (blobKey != null) {
  50       throw new IllegalArgumentException("Cannot specify both a blobKey and a " +
  51           "googleStorageFileName.");
  52     }
  53     this.googleStorageFileName = fileName;
  54     return this;
  55   }
  56
  57   boolean hasGoogleStorageFileName() {
  58     return googleStorageFileName != null;
  59   }
  60
  61   String getGoogleStorageFileName() {
  62     if (googleStorageFileName == null) {
  63       throw new IllegalStateException("googleStorageFileName has not been set.");
  64     }
  65     return googleStorageFileName;
  66   }
  67
  68   public ServingUrlOptions secureUrl(boolean secureUrl) {
  69     this.secureUrl = secureUrl;
  70     return this;
  71   }
  72
  73   boolean hasSecureUrl() {
  74     return secureUrl != null;
  75   }
  76
  77   boolean getSecureUrl() {
  78     if (secureUrl == null) {
  79       throw new IllegalStateException("secureUrl has not been set.");
  80     }
  81     return secureUrl;
  82   }
  83
  84   public ServingUrlOptions crop(boolean crop) {
  85     this.crop = crop;
  86     return this;
  87   }
  88
  89   boolean hasCrop() {
  90     return crop != null;
  91   }
  92
  93   boolean getCrop() {
  94     if (crop == null) {
  95       throw new IllegalStateException("crop has not been set.");
  96     }
  97     return crop;
  98   }
  99
 100   public ServingUrlOptions imageSize(int imageSize) {
 101     if (imageSize > SERVING_SIZES_LIMIT || imageSize < 0) {
 102       throw new IllegalArgumentException("Unsupported size: " + imageSize +
 103           ". Valid sizes must be between 0 and  " + SERVING_SIZES_LIMIT);
 104     }
 105     this.imageSize = imageSize;
 106     return this;
 107   }
 108
 109   boolean hasImageSize() {
 110     return imageSize != null;
 111   }
 112
 113   int getImageSize() {
 114     if (imageSize == null) {
 115       throw new IllegalStateException("imageSize has not been set.");
 116     }
 117     return imageSize;
 118   }
 119
 120   @Override
 121   public int hashCode() {
 122     int hash = 17;
 123     if (blobKey != null) {
 124       hash = hash * 37 + blobKey.hashCode();
 125     }
 126     if (googleStorageFileName != null) {
 127       hash = hash * 37 + googleStorageFileName.hashCode();
 128     }
 129     if (secureUrl != null) {
 130       hash = hash * 37 + secureUrl.hashCode();
 131     }
 132     if (crop != null) {
 133       hash = hash * 37 + crop.hashCode();
 134     }
 135     if (imageSize != null) {
 136       hash = hash * 37 + imageSize.hashCode();
 137     }
 138     return hash;
 139   }
 140
 141   @Override
 142   public boolean equals(Object object) {
 143     if (object instanceof ServingUrlOptions) {
 144       ServingUrlOptions key = (ServingUrlOptions) object;
 145
 146       if (hasBlobKey() != key.hasBlobKey()) {
 147         return false;
 148       }
 149       if (hasBlobKey()) {
 150         if (!blobKey.equals(key.blobKey)) {
 151           return false;
 152         }
 153       }
 154
 155       if (hasGoogleStorageFileName() != key.hasGoogleStorageFileName()) {
 156         return false;
 157       }
 158       if (hasGoogleStorageFileName()) {
 159         if (!googleStorageFileName.equals(key.googleStorageFileName)) {
 160           return false;
 161         }
 162       }
 163
 164       if (hasSecureUrl() != key.hasSecureUrl()) {
 165         return false;
 166       }
 167       if (hasSecureUrl()) {
 168         if (!secureUrl.equals(key.secureUrl)) {
 169           return false;
 170         }
 171       }
 172
 173       if (hasCrop() != key.hasCrop()) {
 174         return false;
 175       }
 176       if (hasCrop()) {
 177         if (!crop.equals(key.crop)) {
 178           return false;
 179         }
 180       }
 181
 182       if (hasImageSize() != key.hasImageSize()) {
 183         return false;
 184       }
 185       if (hasImageSize()) {
 186         if (!imageSize.equals(key.imageSize)) {
 187           return false;
 188         }
 189       }
 190       return true;
 191     }
 192     return false;
 193   }
 194
 195   @Override
 196   public String toString() {
 197     StringBuilder buffer = new StringBuilder("ServingUrlOptions: blobKey=");
 198     if (blobKey != null) {
 199       buffer.append(blobKey.toString());
 200     } else {
 201       buffer.append("None");
 202     }
 203     buffer.append(", googleStorageFileName=");
 204     if (googleStorageFileName != null) {
 205       buffer.append(googleStorageFileName);
 206     } else {
 207       buffer.append("None");
 208     }
 209     buffer.append(", secureUrl=");
 210     if (secureUrl != null) {
 211       buffer.append(secureUrl);
 212     } else {
 213       buffer.append("false");
 214     }
 215     buffer.append(", hasCrop=");
 216     if (crop != null) {
 217       buffer.append(crop);
 218     } else {
 219       buffer.append("false");
 220     }
 221     buffer.append(", imageSize=");
 222     if (imageSize != null) {
 223       buffer.append(imageSize);
 224     } else {
 225       buffer.append("Not Set");
 226     }
 227     buffer.append(".");
 228     return buffer.toString();
 229   }
 230
 231   /**
 232    * Contains static creation methods for {@link ServingUrlOptions}.
 233    */
 234   public static final class Builder {
 235     /**
 236      * Returns default {@link ServingUrlOptions} and calls
 237      * {@link ServingUrlOptions#blobKey(BlobKey)}.
 238      */
 239     public static ServingUrlOptions withBlobKey(BlobKey blobKey) {
 240       return withDefaults().blobKey(blobKey);
 241     }
 242
 243     /**
 244      * Returns default {@link ServingUrlOptions} and calls
 245      * {@link ServingUrlOptions#googleStorageFileName(String)}.
 246      */
 247     public static ServingUrlOptions withGoogleStorageFileName(String googleStorageFileName) {
 248       return withDefaults().googleStorageFileName(googleStorageFileName);
 249     }
 250
 251     /**
 252      * Returns default {@link ServingUrlOptions}.
 253      */
 254     private static ServingUrlOptions withDefaults() {
 255       return new ServingUrlOptions();
 256     }
 257
 258     private Builder() {
 259     }
 260   }
 261 }