Image (AppEngine :: appengine-apis 2.0.17 API)

All Superinterfaces:

Serializable
```
public interface Image
extends Serializable
```
Image represents an image that can be manipulated by the ImagesService.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Image.Format
Image formats usable by the images api.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`@Nullable BlobKey`	`getBlobKey()`	If this image is backed by a blob, return the associated `BlobKey`.
`@Nullable Image.Format`	`getFormat()`	Gets the encoding format of the image.
`int`	`getHeight()`	Gets the height of the image.
`byte @Nullable []`	`getImageData()`	Gets the raw imageData of the image.
`int`	`getWidth()`	Gets the width of the image.
`void`	`setImageData(byte[] imageData)`	Sets the image to contain the image data contained in `imageData`.

- Method Detail
  - getWidth
```
int getWidth()
```
    Gets the width of the image.
    
    Returns:
    
    image width
    
    Throws:
    
    IllegalArgumentException - If the imageData provided is invalid
  - getHeight
```
int getHeight()
```
    Gets the height of the image.
    
    Returns:
    
    image height
    
    Throws:
    
    IllegalArgumentException - If the imageData provided is invalid
  - getFormat
```
@Nullable Image.Format getFormat()
```
    Gets the encoding format of the image.
    
    Returns:
    
    image format
    
    Throws:
    
    IllegalArgumentException - If the imageData provided is invalid
  - getImageData
```
byte @Nullable [] getImageData()
```
    Gets the raw imageData of the image.
    
    Returns:
    
    the image data of the image
  - setImageData
```
void setImageData(byte[] imageData)
```
    Sets the image to contain the image data contained in imageData.
    
    Parameters:
    
    imageData - new image data for the image to store
    
    Throws:
    
    IllegalArgumentException - If imageData is null or empty
  - getBlobKey
```
@Nullable BlobKey getBlobKey()
```
    If this image is backed by a blob, return the associated BlobKey. If this method returns non-null, none of the other methods will currently be available.