|
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.DefinitionObject
@AAFClass(uuid1=218169601, uuid2=257, uuid3=6656, uuid4={6,14,43,52,2,6,1,1}, definedName="DefinitionObject", description="The DefinitionObject class defines an item to be referenced.") public abstract class DefinitionObject
Implements a definition to be referenced.
THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
DefinitionObject.DefinitionObjectXMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Constructor Summary | |
---|---|
DefinitionObject()
|
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. |
DefinitionObject |
clone()
Creates a cloned copy of this entity. |
boolean |
equals(Object o)
Two definitions are equal if and only if their AUID identifications are equals. |
AUID |
getAUID()
Returns the identification of the definition. |
String |
getDescription()
Returns the optional description of the definition. |
String |
getLocalizedUID()
|
String |
getName()
Returns the name of the definition. |
int |
hashCode()
Returns a hash code value for this interchange object. |
void |
setDescription(String description)
Sets the description of this definition, which provides an explanation of the use of the item being defined. |
void |
setLocalizedUID(String localizedUID)
|
void |
setName(String name)
Sets the display name of this definition. |
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.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 DefinitionObject()
Method Detail |
---|
@AAFProperty(uuid1=16848131, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Identification", typeName="AUID", optional=false, uniqueIdentifier=true, pid=6913) public AUID getAUID()
DefinitionType
Returns the identification of the definition. This is normally a registered SMPTE universal label.
getAUID
in interface DefinitionType
getAUID
in interface DefinitionObject
@AAFProperty(uuid1=17236226, uuid2=769, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Name", typeName="String", optional=false, uniqueIdentifier=false, pid=6914) public String getName()
DefinitionType
Returns the name of the definition.
getName
in interface DefinitionType
getName
in interface DefinitionObject
public void setName(String name) throws NullPointerException
DefinitionObject
Sets the display name of this definition.
setName
in interface DefinitionObject
name
- The display name of the item being defined.
NullPointerException
- The given display name is null
.@AAFProperty(uuid1=50463489, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Description", typeName="String", optional=true, uniqueIdentifier=false, pid=6915) public String getDescription() throws PropertyNotPresentException
DefinitionType
Returns the optional description of the definition.
getDescription
in interface DefinitionType
getDescription
in interface DefinitionObject
PropertyNotPresentException
- The optional name property is not present for the
definition.public void setDescription(String description)
DefinitionObject
Sets the description of this definition, which provides an explanation
of the use of the item being defined. Set this optional property to null
to
omit it.
setDescription
in interface DefinitionObject
description
- An explanation of the use of the item being defined.public String getLocalizedUID()
public void setLocalizedUID(String localizedUID)
public boolean equals(Object o)
Two definitions are equal if and only if their AUID identifications are equals.
equals
in interface MAJCommon
equals
in class Object
o
- Object to test for equality with.
Object.equals(java.lang.Object)
public int hashCode()
MAJCommon
Returns a hash code value for this interchange object.
hashCode
in interface MAJCommon
hashCode
in class Object
Object.hashCode()
public DefinitionObject 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 Object
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 InterchangeObject
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 |