io.scif.formats.tiff

Enum FillOrder

java.lang.Object

java.lang.Enum<FillOrder>

io.scif.formats.tiff.FillOrder

All Implemented Interfaces:

CodedEnum, Serializable, Comparable<FillOrder>

public enum FillOrder
extends Enum<FillOrder>
implements CodedEnum

Utility class for working with TIFF fill orders. From the TIFF specification, a fill order is "the logical order of bits within a byte."

Author:

Curtis Rueden, Eric Kjellman, Melissa Linkert, Chris Allan

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL Pixels are arranged within a byte such that pixels with lower column values are stored in the higher-order bits of the byte.
REVERSED Pixels are arranged within a byte such that pixels with lower column values are stored in the lower-order bits of the byte.

Method Summary

Modifier and Type	Method and Description
static FillOrder	get(int code) Retrieves a fill order by reverse lookup of its "code".
int	getCode() Retrieves the integer "code" for this enumeration.
String	getName() Retrieves the given name of the fill order.
static FillOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static FillOrder[]	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

NORMAL

public static final FillOrder NORMAL

Pixels are arranged within a byte such that pixels with lower column values are stored in the higher-order bits of the byte.

1-bit uncompressed data example: Pixel 0 of a row is stored in the high-order bit of byte 0, pixel 1 is stored in the next-highest bit, ..., pixel 7 is stored in the low-order bit of byte 0, pixel 8 is stored in the high-order bit of byte 1, and so on.

CCITT 1-bit compressed data example: The high-order bit of the first compression code is stored in the high-order bit of byte 0, the next-highest bit of the first compression code is stored in the next-highest bit of byte 0, and so on.

REVERSED

public static final FillOrder REVERSED

Pixels are arranged within a byte such that pixels with lower column values are stored in the lower-order bits of the byte.

We recommend that FillOrder=2 be used only in special-purpose applications. It is easy and inexpensive for writers to reverse bit order by using a 256-byte lookup table. FillOrder = 2 should be used only when BitsPerSample = 1 and the data is either uncompressed or compressed using CCITT 1D or 2D compression, to avoid potentially ambigous situations.

Support for FillOrder=2 is not required in a Baseline TIFF compliant reader.

Method Detail

values

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

Returns:

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

valueOf

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

get

public static FillOrder get(int code)

Retrieves a fill order by reverse lookup of its "code".

Parameters:

code - The code to look up.

Returns:

The FillOrder instance for the code or null if it does not exist.

getCode

public int getCode()

Description copied from interface: CodedEnum

Retrieves the integer "code" for this enumeration. It is expected that the code be unique across the enumerated type.

Specified by:

getCode in interface CodedEnum

Returns:

See above.

getName

public String getName()

Retrieves the given name of the fill order.

Returns:

See above.