com.flagstone.transform.util.image
Enum ImageEncoding

java.lang.Object
  java.lang.Enum<ImageEncoding>
      com.flagstone.transform.util.image.ImageEncoding

All Implemented Interfaces:

Serializable, Comparable<ImageEncoding>

public enum ImageEncoding
extends Enum<ImageEncoding>

ImageEncoding describes the different image formats that can be decoded and added to a Flash movie.

Enum Constant Summary

BMP
Windows Bitmap images.

JPEG
Joint Photographic Experts Group format images.

PNG
Portable Network Graphics images.

Method Summary

String	getMimeType() Get the mime-type used to represent the image format.
ImageProvider	getProvider() Get the ImageProvider that can be registered in the ImageRegistry to decode the image.
static ImageEncoding	valueOf(String name) Returns the enum constant of this type with the specified name.
static ImageEncoding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BMP

public static final ImageEncoding BMP

Windows Bitmap images.

JPEG

public static final ImageEncoding JPEG

Joint Photographic Experts Group format images.

PNG

public static final ImageEncoding PNG

Portable Network Graphics images.

Method Detail

values

public static ImageEncoding[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ImageEncoding c : ImageEncoding.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ImageEncoding valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMimeType

public String getMimeType()

Get the mime-type used to represent the image format.

Returns:

the string identifying the image format.

getProvider

public ImageProvider getProvider()

Get the ImageProvider that can be registered in the ImageRegistry to decode the image.

Returns:

the ImageProvider that can be used to decode images of the given mime-type.