Media Authoring
with Java API

tv.amwa.maj.enumeration
Enum ByteOrder

java.lang.Object
  extended by java.lang.Enum<ByteOrder>
      extended by tv.amwa.maj.enumeration.ByteOrder
All Implemented Interfaces:
Serializable, Comparable<ByteOrder>, AAFEnumerationValue

public enum ByteOrder
extends Enum<ByteOrder>
implements AAFEnumerationValue

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

Author:
Richard Cartwright
See Also:
Header, TypeDefinitionStream

Enum Constant Summary
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.
 
Method Summary
 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.
 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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface tv.amwa.maj.enumeration.AAFEnumerationValue
name
 

Enum Constant Detail

Little

public 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').


Big

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').

Method Detail

values

public static final ByteOrder[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ByteOrder c : ByteOrder.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ByteOrder valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

value

@Int64
public long value()
Description copied from interface: AAFEnumerationValue

Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.

Specified by:
value in interface AAFEnumerationValue
Returns:
Unique integer value associated with an enumeration constant.

getAAFByteOrderCode

@Int16
public short getAAFByteOrderCode()

Returns the code used to represent this byte order in an AAF file.

Returns:
Code used to represent this byte order in an AAF file.

getByteOrderFromAAFCode

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.

Parameters:
code - Code used to represent byte order from an AAF file.
Returns:
Element of this enumeration representing the given code.
Throws:
IllegalArgumentException - The given value is not recognised as one of the codes representing byte order in an AAF file.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.