Module org.praxislive.core
Package org.praxislive.core

Enum Class ControlInfo.Type

java.lang.Object
java.lang.Enum<ControlInfo.Type>
org.praxislive.core.ControlInfo.Type
All Implemented Interfaces:
Serializable, Comparable<ControlInfo.Type>, Constable
Enclosing class:
ControlInfo
public static enum ControlInfo.Type extends Enum<ControlInfo.Type>
The types of a control.

  • Enum Constant Details

    • Function

      public static final ControlInfo.Type Function
      A control that acts as a function, taking any number of input arguments, and responding with any number of output arguments.

    • Action

      public static final ControlInfo.Type Action
      A control that triggers an action. An action control always has no input or output arguments.

    • Property

      public static final ControlInfo.Type Property
      A control that acts as a property. A property control accepts an optional single input argument to set the property, and always responds with a single output argument with the value of the property.

      To query the property value without changing it, the control accepts a call with no input arguments. The input ArgumentInfo should always be treated as optional, and does not need to be marked with ArgumentInfo.KEY_OPTIONAL.

    • ReadOnlyProperty

      public static final ControlInfo.Type ReadOnlyProperty
      A control that acts as a read-only property. A read-only property control always has no input arguments, and a single output argument representing the value of the property.

  • Method Details

    • values

      public static ControlInfo.Type[] 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 ControlInfo.Type 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