io.scif.formats.tiff

Enum ResolutionUnit

java.lang.Object

java.lang.Enum<ResolutionUnit>

io.scif.formats.tiff.ResolutionUnit

All Implemented Interfaces:

CodedEnum, Serializable, Comparable<ResolutionUnit>

public enum ResolutionUnit
extends Enum<ResolutionUnit>
implements CodedEnum

Utility class for working with TIFF resolution units. From the TIFF specification, a resolution unit is "the unit of measurement for XResolution and YResolution."

Author:

Curtis Rueden

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTIMETER
INCH
NONE No absolute unit of measurement.

Method Summary

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

NONE

public static final ResolutionUnit NONE

No absolute unit of measurement. Used for images that may have a non-square aspect ratio, but no meaningful absolute dimensions.

INCH

public static final ResolutionUnit INCH

CENTIMETER

public static final ResolutionUnit CENTIMETER

Method Detail

values

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

Returns:

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

valueOf

public static ResolutionUnit 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 ResolutionUnit get(int code)

Retrieves a resolution unit by reverse lookup of its "code".

Parameters:

code - The code to look up.

Returns:

The ResolutionUnit 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 resolution unit.

Returns:

See above.