@MediaClass(uuid1=218169601, uuid2=257, uuid3=15616, uuid4={6,14,43,52,2,6,1,1}, definedName="ConstantValue", description="The ConstantValue class specifies a constant data value for an effect control value.", symbol="ConstantValue") public class ConstantValueImpl extends ParameterImpl implements ConstantValue, Serializable, XMLSerializable, Cloneable
Implements a constant data value for an effect control value. Use varying values and one or more control points for parameters which change in value during the operation group.
ObjectClassPropertyID| Constructor and Description |
|---|
ConstantValueImpl()
Default constructor is not public to avoid unset required fields.
|
ConstantValueImpl(ParameterDefinition parameterDefinition,
Object value)
Creates and initializes a new constant value object that is identified with the
given parameter definition and the value of the constant.
|
| Modifier and Type | Method and Description |
|---|---|
ConstantValue |
clone()
Create a cloned copy of this interchange object.
|
PropertyValue |
getValue()
Returns the value of this constant value object, which is a
property value that
contains the type and current value.
|
byte[] |
getValuePersist() |
static PropertyValue |
initializeValue() |
void |
setValue(PropertyValue value)
Set the value of this constant value.
|
void |
setValuePersist(byte[] value) |
getComment, getParameterDefinition, getParameterDefinitionReference, getParameterDefinitionReferenceString, getTypeDefinition, initializeParameterDefinitionReference, setParameterDefinition, setParameterDefinitionReference, setParameterDefinitionReferenceFromStream, setParameterDefinitionReferenceStringaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetTypeDefinitiongetParameterDefinition, getParameterDefinitionReferenceaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexappendXMLChildren, getCommentpublic ConstantValueImpl()
public ConstantValueImpl(ParameterDefinition parameterDefinition, Object value) throws NullPointerException, ClassCastException
Creates and initializes a new constant value object that is identified with the given parameter definition and the value of the constant.
Note that a data type may allow the value of a property to be null.
parameterDefinition - Parameter definition for this object. This determines
the type of the constant value.value - Buffer containing the constant's value.NullPointerException - The parameter definition is null.ClassCastException - The given value cannot be converted to a value compatible
with the type definition of the parameter.@MediaProperty(uuid1=87033095, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Value", aliases="ConstantValueValue", typeName="Indirect", optional=false, uniqueIdentifier=false, pid=19713, symbol="Value") public PropertyValue getValue()
ConstantValueReturns the value of this constant value object, which is a property value that contains the type and current value.
getValue in interface ConstantValuePropertyValue.getValue(),
PropertyValue.getType()@MediaPropertySetter(value="Value") public void setValue(PropertyValue value) throws NullPointerException, ClassCastException
ConstantValueSet the value of this constant value.
To create a property value of a specific type, use the
createValue() method of a
type definition. To access a type definition, use
the ConstantValue.getTypeDefinition() method as follows:
constantValue.setValue(
constantValue.getTypeDefinition().createValue(42));
Alternatively, you can retrieve the value of any other property using its property definition. To retrieve the property value of a property called foo from an instance called bar:
ClassDefinition barClassDef =
ClassDefinitionWarehouse.forClass(bar.getClass());
PropertyDefinition fooDefinition =
barClassDef.lookupPropertyDefinition("foo");
PropertyValue fooValue =
fooDefinition.getPropertyValue(bar);
setValue in interface ConstantValuevalue - Value and type to of this constant value.NullPointerException - The given value is null.ClassCastExceptionTypeDefinition.createValue(Object),
PropertyValue.getValue(),
Warehouse.lookForType(String)public static final PropertyValue initializeValue()
public ConstantValue clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface ConstantValueclone in interface InterchangeObjectclone in interface Parameterclone in class ParameterImplpublic byte[] getValuePersist()
throws NullPointerException,
IllegalPropertyValueException,
InsufficientSpaceException
public void setValuePersist(byte[] value)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.