- java.lang.Object
-
- org.praxislive.core.Value
-
- org.praxislive.core.ControlInfo
-
public class ControlInfo extends Value
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ControlInfo.Type
-
Field Summary
Fields Modifier and Type Field Description static String
KEY_DEPRECATED
static String
KEY_EXPERT
static String
KEY_TRANSIENT
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ControlInfo.Type
controlType()
static ControlInfo
createActionInfo(PMap properties)
static ControlInfo
createFunctionInfo(List<ArgumentInfo> inputs, List<ArgumentInfo> outputs, PMap properties)
static ControlInfo
createPropertyInfo(List<ArgumentInfo> arguments, List<Value> defaults, PMap properties)
static ControlInfo
createPropertyInfo(ArgumentInfo argument, Value def, PMap properties)
static ControlInfo
createReadOnlyPropertyInfo(List<ArgumentInfo> arguments, PMap properties)
static ControlInfo
createReadOnlyPropertyInfo(ArgumentInfo argument, PMap properties)
List<Value>
defaults()
boolean
equals(Object obj)
Values must override the default equals method.static Optional<ControlInfo>
from(Value arg)
int
hashCode()
Values must override the default hashcode method.List<ArgumentInfo>
inputs()
List<ArgumentInfo>
outputs()
static ControlInfo
parse(String string)
PMap
properties()
String
toString()
Values must override the default method to return a string representation that is immutable.
-
-
-
Field Detail
-
KEY_TRANSIENT
public static final String KEY_TRANSIENT
- See Also:
- Constant Field Values
-
KEY_DEPRECATED
public static final String KEY_DEPRECATED
- See Also:
- Constant Field Values
-
KEY_EXPERT
public static final String KEY_EXPERT
- See Also:
- Constant Field Values
-
-
Method Detail
-
toString
public String toString()
Description copied from class:Value
Values must override the default method to return a string representation that is immutable.
-
hashCode
public int hashCode()
Description copied from class:Value
Values must override the default hashcode method.
-
equals
public boolean equals(Object obj)
Description copied from class:Value
Values must override the default equals method. This method should only returntrue
if the supplied Object is of the same type as the implementing Value. Values of an unknown type should be coerced before calling this method. This method does not have to guarantee thatthis.equals(that) == this.toString().equals(that.toString())
-
controlType
public ControlInfo.Type controlType()
-
properties
public PMap properties()
-
inputs
public List<ArgumentInfo> inputs()
-
outputs
public List<ArgumentInfo> outputs()
-
createFunctionInfo
public static ControlInfo createFunctionInfo(List<ArgumentInfo> inputs, List<ArgumentInfo> outputs, PMap properties)
-
createActionInfo
public static ControlInfo createActionInfo(PMap properties)
-
createPropertyInfo
public static ControlInfo createPropertyInfo(ArgumentInfo argument, Value def, PMap properties)
-
createPropertyInfo
public static ControlInfo createPropertyInfo(List<ArgumentInfo> arguments, List<Value> defaults, PMap properties)
-
createReadOnlyPropertyInfo
public static ControlInfo createReadOnlyPropertyInfo(ArgumentInfo argument, PMap properties)
-
createReadOnlyPropertyInfo
public static ControlInfo createReadOnlyPropertyInfo(List<ArgumentInfo> arguments, PMap properties)
-
from
public static Optional<ControlInfo> from(Value arg)
-
parse
public static ControlInfo parse(String string) throws ValueFormatException
- Throws:
ValueFormatException
-
-