tv.amwa.maj.iface
Interface TypeDefinitionCharacter

All Superinterfaces:

MetaDefinition, TypeDefinition

All Known Implementing Classes:

TypeDefinitionCharacter

public interface TypeDefinitionCharacter
extends TypeDefinition

Specifies the definition of a property type that has a value of a single 2-byte character. The AAF character type is equivalent to the Java char primitive type and a value of Character.

Author:

Richard Cartwright

See Also:

makeTypeDefinitionCharacter(), TypeCategory.Character, Character

Method Summary

PropertyValue	createValueFromCharacter(char character) Create a new property value of character type from the given single character.
char	getCharacter(PropertyValue characterProperty) Returns the character that is the value of the given character property value.
void	setCharacter(PropertyValue characterProperty, char character) Sets the given character as the value of the given character property value.

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

createValue, getTypeCategory

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

getAUID, getDescription, getName, setDescription, setName

Method Detail

createValueFromCharacter

PropertyValue createValueFromCharacter(char character)

Create a new property value of character type from the given single character.

Parameters:

character - Character to use to create a new property value.

Returns:

New property value with a character value matching the given character.

See Also:

setCharacter(PropertyValue, char)

getCharacter

char getCharacter(PropertyValue characterProperty)
                  throws NullPointerException,
                         IllegalPropertyValueException

Returns the character that is the value of the given character property value.

Parameters:

characterProperty - Property value containing the character to return.

Returns:

Value of the given property value.

Throws:

NullPointerException - The given property value is null.

IllegalPropertyValueException - The given property value is not a character property value.

See Also:

PropertyValue.getType()

setCharacter

void setCharacter(PropertyValue characterProperty,
                  char character)
                  throws NullPointerException,
                         IllegalPropertyValueException

Sets the given character as the value of the given character property value.

Parameters:

characterProperty - Property value of character type to set the character for.

character - Character to set as the value of the given property value.

Throws:

NullPointerException - The given character property value is null.

IllegalPropertyValueException - The given property value is not a a character property value.

See Also:

createValueFromCharacter(char)