Module de.bernd_michaely.x3f.types

Package de.bernd_michaely.x3f.types

Enum EnumX3fImageDataFormat

java.lang.Object

java.lang.Enum<EnumX3fImageDataFormat>

de.bernd_michaely.x3f.types.EnumX3fImageDataFormat

All Implemented Interfaces:

Serializable, Comparable<EnumX3fImageDataFormat>

public enum EnumX3fImageDataFormat
extends Enum<EnumX3fImageDataFormat>

An enumeration to represent X3F image data formats.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HUFFMAN_DPCM_ENCODED	Huffman-encoded DPCM 8/8/8 RGB
JPEG_COMPRESSED	JPEG-compressed 8/8/8 RGB
RESERVED	RESERVED
UNCOMPRESSED_24BIT_RGB	uncompressed 24-bit 8/8/8 RGB

Method Summary

Modifier and Type	Method	Description
static EnumX3fImageDataFormat	getByNumericValue(int value)	Returns the enumeration constant representing the numeric value of the data format.
abstract String	getDescription()	Returns a description of the data format.
abstract boolean	isDecodingSupported()	Returns true, if decoding of the format is supported by this library.
abstract boolean	isJpegCompressed()	Returns true, if the data format is an JPEG compressed format.
static EnumX3fImageDataFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EnumX3fImageDataFormat[]	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

UNCOMPRESSED_24BIT_RGB

public static final EnumX3fImageDataFormat UNCOMPRESSED_24BIT_RGB

uncompressed 24-bit 8/8/8 RGB

HUFFMAN_DPCM_ENCODED

public static final EnumX3fImageDataFormat HUFFMAN_DPCM_ENCODED

Huffman-encoded DPCM 8/8/8 RGB

JPEG_COMPRESSED

public static final EnumX3fImageDataFormat JPEG_COMPRESSED

JPEG-compressed 8/8/8 RGB

RESERVED

public static final EnumX3fImageDataFormat RESERVED

RESERVED

Method Detail

values

public static EnumX3fImageDataFormat[] 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 (EnumX3fImageDataFormat c : EnumX3fImageDataFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static EnumX3fImageDataFormat 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

isDecodingSupported

public abstract boolean isDecodingSupported()

Returns true, if decoding of the format is supported by this library.

Returns:

true, if decoding of the format is supported by this library

isJpegCompressed

public abstract boolean isJpegCompressed()

Returns true, if the data format is an JPEG compressed format.

Returns:

true, if the data format is an JPEG compressed format

getDescription

public abstract String getDescription()

Returns a description of the data format.

Returns:

a description of the data format

getByNumericValue

public static EnumX3fImageDataFormat getByNumericValue(int value)

Returns the enumeration constant representing the numeric value of the data format.

Parameters:

value - the numeric value of the data format

Returns:

the enumeration constant representing the numeric value