au.com.southsky.jfreesane

Enum SaneOption.OptionUnits

java.lang.Object

java.lang.Enum<SaneOption.OptionUnits>

au.com.southsky.jfreesane.SaneOption.OptionUnits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SaneOption.OptionUnits>

Enclosing class:

SaneOption

public static enum SaneOption.OptionUnits
extends java.lang.Enum<SaneOption.OptionUnits>

Instances of this enum are returned by SaneOption.getUnits() indicating what units, if any, the value has.

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNIT_BIT The option unit is bits.
UNIT_DPI The option unit is dots per inch.
UNIT_MICROSECOND The option unit is microseconds.
UNIT_MM The option unit is millimeters.
UNIT_NONE The option has no units.
UNIT_PERCENT The option unit is a percentage.
UNIT_PIXEL The option unit is pixels.

Method Summary

Modifier and Type	Method and Description
int	getWireValue() Returns the integer used by the SANE network protocol to represent an instance of this enum on the wire.
static SaneOption.OptionUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SaneOption.OptionUnits[]	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

UNIT_NONE

public static final SaneOption.OptionUnits UNIT_NONE

The option has no units.

UNIT_PIXEL

public static final SaneOption.OptionUnits UNIT_PIXEL

The option unit is pixels.

UNIT_BIT

public static final SaneOption.OptionUnits UNIT_BIT

The option unit is bits.

UNIT_MM

public static final SaneOption.OptionUnits UNIT_MM

The option unit is millimeters.

UNIT_DPI

public static final SaneOption.OptionUnits UNIT_DPI

The option unit is dots per inch.

UNIT_PERCENT

public static final SaneOption.OptionUnits UNIT_PERCENT

The option unit is a percentage.

UNIT_MICROSECOND

public static final SaneOption.OptionUnits UNIT_MICROSECOND

The option unit is microseconds.

Method Detail

values

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

Returns:

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

valueOf

public static SaneOption.OptionUnits valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getWireValue

public int getWireValue()

Returns the integer used by the SANE network protocol to represent an instance of this enum on the wire.