tv.amwa.maj.iface
Interface KLVDataDefinition

All Superinterfaces:

DefinitionObject, InterchangeObject

All Known Implementing Classes:

KLVDataDefinition

public interface KLVDataDefinition
extends DefinitionObject

Specifies the documentation for the KLV data objects used in a file.

The identification property of the definition object super-class shall identify a particular AUID that is used for the key of instances of the KLV data being documented.

Author:

Richard Cartwright

See Also:

makeKLVDataDefinition(), Dictionary.getKLVDataDefinitions()

Method Summary

TypeDefinition	getKLVDataType() Returns the KLV data type property for this KLV data definition, which specifies the type of the value of the documented KLV data.
void	setKLVDataType(TypeDefinition typeDefinition) Sets the KLV data type property of this KLV data definition, which specifies the type of the value of the documented KLV data.

Methods inherited from interface tv.amwa.maj.iface.DefinitionObject

getAUID, getDescription, getName, setDescription, setName

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getKLVDataType

TypeDefinition getKLVDataType()

Returns the KLV data type property for this KLV data definition, which specifies the type of the value of the documented KLV data.

If this optional property is omitted, the default value of a reference to the type named "VariableArray of UInt8" is returned.

Returns:

The type definition referenced by this KLV data definition.

See Also:

TypeDefinitionOpaque

setKLVDataType

void setKLVDataType(TypeDefinition typeDefinition)

Sets the KLV data type property of this KLV data definition, which specifies the type of the value of the documented KLV data.

To omit this optional property, call this method with null.

Parameters:

typeDefinition - Referenced type definition that is the KLV data type property of this KLV data definition.