au.com.southsky.jfreesane

Enum OptionValueConstraintType

java.lang.Object

java.lang.Enum<OptionValueConstraintType>

au.com.southsky.jfreesane.OptionValueConstraintType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OptionValueConstraintType>

public enum OptionValueConstraintType
extends java.lang.Enum<OptionValueConstraintType>

Represents the types of constraints that a SaneOption may be subjected to.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_CONSTRAINT The option has no constraints on its value.
RANGE_CONSTRAINT The option's value is constrained to some range of values.
STRING_LIST_CONSTRAINT The option's value type is OptionValueType.STRING and its value is constrained to some list of string values.
VALUE_LIST_CONSTRAINT The option's value is constrained to some list of values.

Method Summary

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

NO_CONSTRAINT

public static final OptionValueConstraintType NO_CONSTRAINT

The option has no constraints on its value.

RANGE_CONSTRAINT

public static final OptionValueConstraintType RANGE_CONSTRAINT

The option's value is constrained to some range of values.

VALUE_LIST_CONSTRAINT

public static final OptionValueConstraintType VALUE_LIST_CONSTRAINT

The option's value is constrained to some list of values.

STRING_LIST_CONSTRAINT

public static final OptionValueConstraintType STRING_LIST_CONSTRAINT

The option's value type is OptionValueType.STRING and its value is constrained to some list of string values.

Method Detail

values

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

Returns:

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

valueOf

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

description

public java.lang.String description()

Returns the description of the option as provided by the SANE backend.

getWireValue

public int getWireValue()

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