tv.amwa.maj.iface
Interface ConstantValue

All Superinterfaces:

InterchangeObject, Parameter

All Known Implementing Classes:

ConstantValue

public interface ConstantValue
extends Parameter

Specifies a 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 value property of a constant value is specified to be of indirect type, which the MAJ API represents as a Java object. This value should be convertible to an AAF property value using TypeDefinition.createValue(Object) for the type specified for this parameter.

Author:

Richard Cartwright

See Also:

makeConstantValue(), ParameterDefinition, TypeDefinitionIndirect, PropertyValue

Method Summary

TypeDefinition	getTypeDefinition() Returns the type definition associated with this constant value, which is the same as the type definition for the parameter definition of this parameter.
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 getTypeDefinition().
void	setValue(Object value) Set the value of this constant value.

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

Method Detail

getValue

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 getTypeDefinition().

Returns:

Value of this constant value.

getTypeDefinition

TypeDefinition getTypeDefinition()

Returns the type definition associated with this constant value, which is the same as the type definition for the parameter definition of this parameter.

Specified by:

getTypeDefinition in interface Parameter

Returns:

Type definition of the data value inside of this object.

See Also:

Parameter.getTypeDefinition(), ParameterDefinition.getTypeDefinition()

setValue

void setValue(Object value)
              throws NullPointerException,
                     ClassCastException

Set the value of this constant value.

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