public class EssenceFormat extends Object implements EssenceFormat, Serializable
| Constructor and Description |
|---|
EssenceFormat()
Creates and initializes an empty essence format list.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addFormatSpecifier(AUID essenceFormatCode,
byte[] value)
Appends a format specifier to the essence format.
|
static EssenceFormat |
castFromInterface(EssenceFormat alien)
Cast a
EssenceFormat
value from the generic interface to this implementation of
the interface. |
byte[] |
getFormatSpecifier(AUID essenceFormatCode)
Data value representing the essence format of the given
essence format code.
|
AUIDImpl |
getIndexedEssenceFormatCode(int index)
Returns the essence format code associated with the format
specifier at the given index.
|
byte[] |
getIndexedFormatSpecifier(int index)
Returns the data value at the given index.
|
int |
numSpecifiers()
Returns the number of specifiers present in this essence
format.
|
public EssenceFormat()
Creates and initializes an empty essence format list.
public static final EssenceFormat castFromInterface(EssenceFormat alien) throws NullPointerException
Cast a EssenceFormat
value from the generic interface to this implementation of
the interface. If the given value is not a native implementation, a copy will be
instanciated using get and set methods.
alien - A potentially alien implementation of an instance of the EssenceFormat
interface.NullPointerException - Argument is null.public void addFormatSpecifier(AUID essenceFormatCode, byte[] value) throws NullPointerException
EssenceFormatAppends a format specifier to the essence format. If a particular essence format code has already been added, then this call replaces the value, otherwise the value is added.
addFormatSpecifier in interface EssenceFormatessenceFormatCode - Essence format code (as defined in
"aafdefuids.h").value - Data value for format specifier.NullPointerException - One or more of the arguments is null.EssenceFormat.addFormatSpecifier(tv.amwa.maj.record.AUID, byte[])public byte[] getFormatSpecifier(AUID essenceFormatCode) throws NullPointerException
EssenceFormatData value representing the essence format of the given essence format code.
getFormatSpecifier in interface EssenceFormatessenceFormatCode - Essence format code (as defined in
"aafdefuids.h").NullPointerException - Argument is null.EssenceFormat.getFormatSpecifier(tv.amwa.maj.record.AUID)public AUIDImpl getIndexedEssenceFormatCode(int index) throws IndexOutOfBoundsException
EssenceFormatReturns the essence format code associated with the format specifier at the given index.
getIndexedEssenceFormatCode in interface EssenceFormatindex - 0-based index for the format specifier to retrieve.IndexOutOfBoundsException - The specified index is
outside the acceptable range for the current number of specifiers.EssenceFormat.getIndexedEssenceFormatCode(int)public byte[] getIndexedFormatSpecifier(int index)
throws IndexOutOfBoundsException
EssenceFormatReturns the data value at the given index.
getIndexedFormatSpecifier in interface EssenceFormatindex - 0-based index for the format specifier to retrieve.IndexOutOfBoundsException - The specified index is
outside the acceptable range for the current number of specifiers.EssenceFormat.getIndexedFormatSpecifier(int)public int numSpecifiers()
EssenceFormatReturns the number of specifiers present in this essence format.
numSpecifiers in interface EssenceFormatEssenceFormat.numSpecifiers()(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.