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

   1 // Copyright 2009 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.images;
   4
   5 import com.google.appengine.api.blobstore.BlobKey;
   6
   7 import java.io.Serializable;
   8
   9 /**
  10  * {@code Image} represents an image that can be manipulated by the
  11  * {@link ImagesService}.
  12  *
  13  */
  14 public interface Image extends Serializable {
  15
  16   /**
  17    * Image formats usable by the images api.
  18    */
  19   public enum Format {PNG, JPEG, GIF, TIFF, BMP, ICO, WEBP}
  20
  21   /**
  22    * Gets the width of the image.
  23    * @return image width
  24    * @throws IllegalArgumentException If the {@code imageData} provided is
  25    *                                  invalid
  26    */
  27   public int getWidth();
  28
  29   /**
  30    * Gets the height of the image.
  31    * @return image height
  32    * @throws IllegalArgumentException If the {@code imageData} provided is
  33    *                                  invalid
  34    */
  35   public int getHeight();
  36
  37   /**
  38    * Gets the encoding format of the image.
  39    * @return image format
  40    * @throws IllegalArgumentException If the {@code imageData} provided is
  41    * invalid
  42    */
  43   public Format getFormat();
  44
  45   /**
  46    * Gets the raw imageData of the image.
  47    * @return the image data of the image
  48    */
  49   public byte[] getImageData();
  50
  51   /**
  52    * Sets the image to contain the image data contained in {@code imageData}.
  53    * @param imageData new image data for the image to store
  54    * @throws IllegalArgumentException If {@code imageData} is null or empty
  55    */
  56   public void setImageData(byte[] imageData);
  57
  58   /**
  59    * If this image is backed by a blob, return the associated {@link
  60    * BlobKey}.  If this method returns non-{@code null}, none of the
  61    * other methods will currently be available.
  62    */
  63   public BlobKey getBlobKey();
  64 }