tv.amwa.maj.entity
Class ConstantValue

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Parameter
          tv.amwa.maj.entity.ConstantValue

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, ConstantValue, InterchangeObject, Parameter, XMLSerializable

@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
extends Parameter
implements ConstantValue, Serializable, Cloneable, MAJCommon

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.

Author:

Richard Cartwright

See Also:

Serialized Form

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

ConstantValue

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.

Parameters:

parameterDefinition - Parameter definition for this object. This determines the type of the constant value.

value - Buffer containing the constant's value.

Throws:

NullPointerException - Either of the arguments is null.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(ConstantValue castFrom)

See Also:

InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getValue

@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()

Description copied from interface: 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().

Specified by:

getValue in interface ConstantValue

Returns:

Value of this constant value.

setValue

public void setValue(Object value)
              throws NullPointerException,
                     ClassCastException

Description copied from interface: ConstantValue

Set the value of this constant value.

Specified by:

setValue in interface ConstantValue

Parameters:

value - Value to set for this contant value.

Throws:

NullPointerException - The given value is null.

ClassCastException - The given value cannot be cast to a value of the type of this type definition.

See Also:

TypeDefinition.createValue(Object), PropertyValue.getValue()

equals

public boolean equals(Object o)

Description copied from interface: 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.

Specified by:

equals in interface MAJCommon

Overrides:

equals in class Parameter

Parameters:

o - Object to test for equality with.

Returns:

Is the given object equals to this value?

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from interface: MAJCommon

Returns a hash code value for this interchange object.

Specified by:

hashCode in interface MAJCommon

Overrides:

hashCode in class Parameter

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public ConstantValue clone()

Description copied from interface: 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.

Specified by:

clone in interface MAJCommon

Overrides:

clone in class Parameter

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

appendXMLChildren

public void appendXMLChildren(Node parent)

Description copied from interface: 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.

Specified by:

appendXMLChildren in interface XMLSerializable

Overrides:

appendXMLChildren in class Parameter

Parameters:

parent - XML parent element to append child nodes to.