|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object tv.amwa.maj.entity.InterchangeObject tv.amwa.maj.entity.Parameter tv.amwa.maj.entity.ConstantValue
@AAFClass(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.") public class ConstantValue
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.
THE COMMENTS IN THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
ConstantValue.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Parameter |
---|
Parameter.ParameterXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Constructor Summary | |
---|---|
ConstantValue(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. |
Method Summary | |
---|---|
void |
appendXMLChildren(Node parent)
Append child elements to the given parent node to serialize the value of an object to an XML fragment. |
ConstantValue |
clone()
Creates a cloned copy of this entity. |
boolean |
equals(Object o)
Tests to see if the given object is equal to this interchange object. |
Object |
getValue()
Returns the value of this constant value object, which is a Java object that can be used to represent a value of the defined type, as returned by ConstantValue.getTypeDefinition() . |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setPropertiesFromInterface(ConstantValue castFrom)
|
void |
setValue(Object value)
Set the value of this constant value. |
Methods inherited from class tv.amwa.maj.entity.Parameter |
---|
getDefinitionValue, getId, getParameterDefinition, getTypeDefinition, setId, setParameterDefinition, setPropertiesFromInterface |
Methods inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.ConstantValue |
---|
getTypeDefinition |
Methods inherited from interface tv.amwa.maj.iface.Parameter |
---|
getParameterDefinition |
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject |
---|
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue |
Methods inherited from interface tv.amwa.maj.entity.MAJCommon |
---|
toString |
Constructor Detail |
---|
public ConstantValue(ParameterDefinition parameterDefinition, Object value) throws NullPointerException
Creates and initializes a new constant value object that is identified with the given parameter definition and the value of the constant.
parameterDefinition
- Parameter definition for this object. This determines
the type of the constant value.value
- Buffer containing the constant's value.
NullPointerException
- Either of the arguments is null
.Method Detail |
---|
public final void setPropertiesFromInterface(ConstantValue castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
@AAFProperty(uuid1=87033095, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Value", typeName="Indirect", optional=false, uniqueIdentifier=false, pid=19713) public Object getValue()
ConstantValue
Returns the value of this constant value object, which is a Java object that
can be used to represent a value of the defined type, as returned by
ConstantValue.getTypeDefinition()
.
getValue
in interface ConstantValue
public void setValue(Object value) throws NullPointerException, ClassCastException
ConstantValue
Set the value of this constant value.
setValue
in interface ConstantValue
value
- Value to set for this contant value.
NullPointerException
- The given value is null
.
ClassCastException
- The given value cannot be cast to a value of the
type of this type definition.TypeDefinition.createValue(Object)
,
PropertyValue.getValue()
public boolean equals(Object o)
MAJCommon
Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.
equals
in interface MAJCommon
equals
in class Parameter
o
- Object to test for equality with.
Object.equals(Object)
public int hashCode()
MAJCommon
Returns a hash code value for this interchange object.
hashCode
in interface MAJCommon
hashCode
in class Parameter
Object.hashCode()
public ConstantValue clone()
MAJCommon
Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.
This method does not throw a CloneNotSupportedException
as all
entity values must implement the Cloneable
interface. If a cloning
error does occur, a null
value will be returned but this is very unlikely
to happen.
clone
in interface MAJCommon
clone
in class Parameter
Object.clone()
public void appendXMLChildren(Node parent)
XMLSerializable
Append child elements to the given parent node to serialize the value of an object
to an XML fragment. Methods of the XMLBuilder
class are provided to help with this
process.
appendXMLChildren
in interface XMLSerializable
appendXMLChildren
in class Parameter
parent
- XML parent element to append child nodes to.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |