Module org.praxislive.code

Package org.praxislive.code

Enum Class ControlDescriptor.Category

java.lang.Object

java.lang.Enum<ControlDescriptor.Category>

org.praxislive.code.ControlDescriptor.Category

All Implemented Interfaces:

Serializable, Comparable<ControlDescriptor.Category>, Constable

Enclosing class:

ControlDescriptor<T extends ControlDescriptor<T>>

public static enum ControlDescriptor.Category
extends Enum<ControlDescriptor.Category>

Categories of control, which also affects broad ordering of controls.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Action	Controls that correspond to actions.
AuxIn	Controls that correspond to auxiliary input.
Function	Controls that represent functions.
In	Controls that correspond to input.
Internal	Internal controls that are part of the base context implementation, eg. the info and code properties.
Property	Controls that correspond to properties.
Synthetic	Synthetic controls used for injected resources that require a control endpoint.

Method Summary

Modifier and Type	Method	Description
static ControlDescriptor.Category	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ControlDescriptor.Category[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Internal

public static final ControlDescriptor.Category Internal

Internal controls that are part of the base context implementation, eg. the info and code properties.

Synthetic

public static final ControlDescriptor.Category Synthetic

Synthetic controls used for injected resources that require a control endpoint. Excluded from info and display.

In

public static final ControlDescriptor.Category In

Controls that correspond to input.

Action

public static final ControlDescriptor.Category Action

Controls that correspond to actions.

Property

public static final ControlDescriptor.Category Property

Controls that correspond to properties.

AuxIn

public static final ControlDescriptor.Category AuxIn

Controls that correspond to auxiliary input.

Function

public static final ControlDescriptor.Category Function

Controls that represent functions.

Method Details

values

public static ControlDescriptor.Category[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ControlDescriptor.Category valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null