public enum ByteOrder extends Enum<ByteOrder> implements MediaEnumerationValue
Specifies the byte order of a file, such as an AAF file. A ByteOrder property records the byte order of the computer platform on which the file was created. Subsequent modification of the file may create objects with foreign byte order; the byte order of individual modified objects shall be properly maintained by the storage format.
In the big-endian byte order, the most significant byte is stored first at the address specified, which is the lowest address of the series of bytes that constitute the value. In the little-endian byte order, the least-significant byte is stored first. In both cases, each individual byte is stored with the most-significant bit first.
Note that the AAF object
specification v1.1 uses an Int16 value to represent byte order. This
value can be retrieved using getAAFByteOrderCode() method and converted back to a value of this
enumeration using getByteOrderFromAAFCode(short).
Original C name: eByteOrder_e
Preface,
TypeDefinitionStream| Enum Constant and Description |
|---|
Big
Big-endian byte order, where the most significant byte is stored first.
|
Little
Little-endian byte order, where the least significant byte is stored first.
|
| Modifier and Type | Method and Description |
|---|---|
short |
getAAFByteOrderCode()
Returns the code used to represent this byte order in an AAF file.
|
static ByteOrder |
getByteOrderFromAAFCode(short code)
Returns a value of this enumeration matching the given byte order code from an
AAF file.
|
String |
symbol()
Provides a name for the enumeration value that can be used in XML serialisation.
|
long |
value()
Returns the unique integer value associated with an enumeration value, either according
to the AAF specification and/or the current AAF meta dictionary.
|
static ByteOrder |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ByteOrder[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfnamepublic static final ByteOrder Little
Little-endian byte order, where the least significant byte is stored first.
The code used in AAF file to represent little-endian byte order is 0x6c6c ('ll').
public static final ByteOrder Big
Big-endian byte order, where the most significant byte is stored first.
The code used in AAF file to represent big-endian byte order is 0x4d4d ('MM').
public static ByteOrder[] values()
for (ByteOrder c : ByteOrder.values()) System.out.println(c);
public static ByteOrder valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is null@Int64 public long value()
MediaEnumerationValueReturns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.
value in interface MediaEnumerationValuepublic String symbol()
MediaEnumerationValueProvides a name for the enumeration value that can be used in XML serialisation. The name is unique within the namespace of the owning type.
As an example, the ChannelStatusModeType value ChannelStatusModeType.Fixed
value has the name "Fixed" and symbol "ChannelStatusMode_Fixed".
symbol in interface MediaEnumerationValue@Int16 public short getAAFByteOrderCode()
Returns the code used to represent this byte order in an AAF file.
public static final ByteOrder getByteOrderFromAAFCode(@Int16 short code) throws IllegalArgumentException
Returns a value of this enumeration matching the given byte order code from an AAF file.
code - Code used to represent byte order from an AAF file.IllegalArgumentException - The given value is not recognised as one of the codes
representing byte order in an AAF file.(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.