heronarts.lx.parameter

Enum LXParameter.Units

java.lang.Object

java.lang.Enum<LXParameter.Units>

heronarts.lx.parameter.LXParameter.Units

All Implemented Interfaces:

LXParameter.Formatter, Serializable, Comparable<LXParameter.Units>

Enclosing interface:

LXParameter

public static enum LXParameter.Units
extends Enum<LXParameter.Units>
implements LXParameter.Formatter

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECIBELS
DEGREES
HERTZ
INTEGER
MIDI_NOTE
MILLISECONDS
NONE
PERCENT
RADIANS
SECONDS

Method Summary

Modifier and Type	Method and Description
String	format(double value)
static String	format(LXParameter.Units units, double value)
static LXParameter.Units	valueOf(String name) Returns the enum constant of this type with the specified name.
static LXParameter.Units[]	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 LXParameter.Units NONE

INTEGER

public static final LXParameter.Units INTEGER

SECONDS

public static final LXParameter.Units SECONDS

MILLISECONDS

public static final LXParameter.Units MILLISECONDS

DECIBELS

public static final LXParameter.Units DECIBELS

HERTZ

public static final LXParameter.Units HERTZ

MIDI_NOTE

public static final LXParameter.Units MIDI_NOTE

DEGREES

public static final LXParameter.Units DEGREES

RADIANS

public static final LXParameter.Units RADIANS

PERCENT

public static final LXParameter.Units PERCENT

Method Detail

values

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

Returns:

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

valueOf

public static LXParameter.Units 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

format

public String format(double value)

Specified by:

format in interface LXParameter.Formatter

format

public static String format(LXParameter.Units units,
                            double value)