Module org.praxislive.core

Package org.praxislive.core

Class ControlInfo

java.lang.Object

org.praxislive.core.Value

org.praxislive.core.types.PMap.MapBasedValue

org.praxislive.core.ControlInfo

public final class ControlInfo
extends PMap.MapBasedValue

Information on the type, inputs, outputs and properties of a Control.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ControlInfo.Type	The types of a control.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_DEFAULTS	Map key for the list of default Values.
static final String	KEY_DEPRECATED	Optional map key to mark a control as deprecated.
static final String	KEY_EXPERT	Optional map key to mark a control as relating to expert / advanced usage.
static final String	KEY_INPUTS	Map key for the inputs list of ArgumentInfo.
static final String	KEY_OUTPUTS	Map key for the outputs list of ArgumentInfo.
static final String	KEY_TRANSIENT	Optional map key to mark a property as transient, and so not to be included in any serialized representation of the component state.
static final String	KEY_TYPE	Map key for the control type.
static final String	TYPE_NAME	Value type name.

Method Summary

Modifier and Type	Method	Description
ControlInfo.Type	controlType()	The type of the control.
static ControlInfo	createActionInfo(PMap properties)	Create ControlInfo for an action control.
static ControlInfo	createFunctionInfo(List<ArgumentInfo> inputs, List<ArgumentInfo> outputs, PMap properties)	Create ControlInfo for a function control.
static ControlInfo	createPropertyInfo(List<ArgumentInfo> arguments, List<Value> defaults, PMap properties)
static ControlInfo	createPropertyInfo(ArgumentInfo argument, Value def, PMap properties)	Create ControlInfo for a property control.
static ControlInfo	createReadOnlyPropertyInfo(List<ArgumentInfo> arguments, PMap properties)
static ControlInfo	createReadOnlyPropertyInfo(ArgumentInfo argument, PMap properties)	Create ControlInfo for a read-only property control.
List<Value>	defaults()	The list of default values.
static Optional<ControlInfo>	from(Value arg)	Coerce the provided Value into a ControlInfo if possible.
List<ArgumentInfo>	inputs()	The list of input ArgumentInfo.
List<ArgumentInfo>	outputs()	The list of output ArgumentInfo.
static ControlInfo	parse(String string)	Parse the provided String into a ControlInfo if possible.
PMap	properties()	Access the map of properties.

Methods inherited from class org.praxislive.core.types.PMap.MapBasedValue

dataMap, equals, equivalent, hashCode, toString

Methods inherited from class org.praxislive.core.Value

info, isEmpty, ofObject, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE_NAME

public static final String TYPE_NAME

Value type name.

See Also:

• Constant Field Values

KEY_TYPE

public static final String KEY_TYPE

Map key for the control type.

See Also:

• Constant Field Values

KEY_INPUTS

public static final String KEY_INPUTS

Map key for the inputs list of ArgumentInfo.

See Also:

• Constant Field Values

KEY_OUTPUTS

public static final String KEY_OUTPUTS

Map key for the outputs list of ArgumentInfo.

See Also:

• Constant Field Values

KEY_DEFAULTS

public static final String KEY_DEFAULTS

Map key for the list of default Values. Only relevant for properties.

See Also:

• Constant Field Values

KEY_TRANSIENT

public static final String KEY_TRANSIENT

Optional map key to mark a property as transient, and so not to be included in any serialized representation of the component state.

See Also:

• Constant Field Values

KEY_DEPRECATED

public static final String KEY_DEPRECATED

Optional map key to mark a control as deprecated.

See Also:

• Constant Field Values

KEY_EXPERT

public static final String KEY_EXPERT

Optional map key to mark a control as relating to expert / advanced usage. A user interface might choose to display such a control in a different way.

See Also:

• Constant Field Values

Method Details

controlType

public ControlInfo.Type controlType()

The type of the control.

Returns:

control type

properties

public PMap properties()

Access the map of properties. The map includes the type, inputs, outputs and defaults, as well as any custom or optional properties.

This method is equivalent to calling PMap.MapBasedValue.dataMap().

Returns:

property map

defaults

public List<Value> defaults()

The list of default values. May be empty if not a property or not specified.

Returns:

list of default values

inputs

public List<ArgumentInfo> inputs()

The list of input ArgumentInfo.

Returns:

input argument info

outputs

public List<ArgumentInfo> outputs()

The list of output ArgumentInfo.

Returns:

output argument info

createFunctionInfo

public static ControlInfo createFunctionInfo(List<ArgumentInfo> inputs,
 List<ArgumentInfo> outputs,
 PMap properties)

Create ControlInfo for a function control.

Parameters:

inputs - list of input info

outputs - list of output info

properties - additional properties (may be null)

Returns:

control info

createActionInfo

public static ControlInfo createActionInfo(PMap properties)

Create ControlInfo for an action control.

Parameters:

properties - additional properties (may be null)

Returns:

control info

createPropertyInfo

public static ControlInfo createPropertyInfo(ArgumentInfo argument,
 Value def,
 PMap properties)

Create ControlInfo for a property control.

Parameters:

argument - property value info

def - default value

properties - additional properties (may be null)

Returns:

control info

createPropertyInfo

public static ControlInfo createPropertyInfo(List<ArgumentInfo> arguments,
 List<Value> defaults,
 PMap properties)

createReadOnlyPropertyInfo

public static ControlInfo createReadOnlyPropertyInfo(ArgumentInfo argument,
 PMap properties)

Create ControlInfo for a read-only property control.

Parameters:

argument - property value info

properties - additional properties (may be null)

Returns:

control info

createReadOnlyPropertyInfo

public static ControlInfo createReadOnlyPropertyInfo(List<ArgumentInfo> arguments,
 PMap properties)

from

public static Optional<ControlInfo> from(Value arg)

Coerce the provided Value into a ControlInfo if possible.

Parameters:

arg - value of unknown type

Returns:

control info or empty optional

parse

public static ControlInfo parse(String string)
                         throws ValueFormatException

Parse the provided String into a ControlInfo if possible.

Parameters:

string - text to parse

Returns:

control info

Throws:

ValueFormatException - if parsing fails