javax.realtime

Enum ByteOrder

java.lang.Object

java.lang.Enum<ByteOrder>

javax.realtime.ByteOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ByteOrder>

public enum ByteOrder
extends java.lang.Enum<ByteOrder>

Defines the possible mappings between bytes and words in memory.

Since:

RTSJ 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIG_ENDIAN Value indicating that the highest order byte of a bit word is stored at the lowest byte address: the int 0x0A0B0C0D is stored in the byte sequence 0x0A, 0x0B, 0x0C, 0x0D.
CROSS_ENDIAN Value indicating a mixed endian mode: the int 0x0A0B0C0D is stored in the byte sequence 0x0D, 0x0C, 0x0B, 0x0A, and the long 0x0102030405060708 is stored in the sequence 0x05, 0x06, 0x07, 0x08, 0x01, 0x02, 0x03, 0x04.
LITTLE_ENDIAN Value indicating that the lowest order byte of a word is stored at the lowest byte address: the int 0x0A0B0C0D is stored in the byte sequence 0x0D, 0x0C, 0x0B, 0x0A and the long 0x0102030405060708 is stored in the sequence 0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01.
PDP_ENDIAN Value indicating a mixed endian mode used by among others the PDP-11: the int 0x0A0B0C0D is stored in the byte sequence 0x0B, 0x0A, 0x0D, 0x0C, and the long 0x0102030405060708 is stored in the sequence 0x02, 0x01, 0x04, 0x03, 0x06, 0x05, 0x08, 0x07.

Method Summary

Modifier and Type	Method and Description
static ByteOrder	systemByteOrder() Obtains the byte order of the byte order of the system.
byte	value() Determines the value of this enum.
static ByteOrder	value(int value) Converts an int into a policy type.
static ByteOrder	value(java.lang.String value) Converts a string into a policy type.
static ByteOrder	valueOf(java.lang.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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BIG_ENDIAN

public static final ByteOrder BIG_ENDIAN

Value indicating that the highest order byte of a bit word is stored at the lowest byte address: the int 0x0A0B0C0D is stored in the byte sequence 0x0A, 0x0B, 0x0C, 0x0D. and the long 0x0102030405060708 is stored in the sequence 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08.

LITTLE_ENDIAN

public static final ByteOrder LITTLE_ENDIAN

Value indicating that the lowest order byte of a word is stored at the lowest byte address: the int 0x0A0B0C0D is stored in the byte sequence 0x0D, 0x0C, 0x0B, 0x0A and the long 0x0102030405060708 is stored in the sequence 0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01.

PDP_ENDIAN

public static final ByteOrder PDP_ENDIAN

Value indicating a mixed endian mode used by among others the PDP-11: the int 0x0A0B0C0D is stored in the byte sequence 0x0B, 0x0A, 0x0D, 0x0C, and the long 0x0102030405060708 is stored in the sequence 0x02, 0x01, 0x04, 0x03, 0x06, 0x05, 0x08, 0x07.

CROSS_ENDIAN

public static final ByteOrder CROSS_ENDIAN

Value indicating a mixed endian mode: the int 0x0A0B0C0D is stored in the byte sequence 0x0D, 0x0C, 0x0B, 0x0A, and the long 0x0102030405060708 is stored in the sequence 0x05, 0x06, 0x07, 0x08, 0x01, 0x02, 0x03, 0x04.

Method Detail

values

public static ByteOrder[] values()

Returns an array containing the constants of this enum type, in the order they are 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 are declared

valueOf

public static ByteOrder valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public byte value()

Determines the value of this enum.

Returns:

the corresponding integer.

value

public static ByteOrder value(java.lang.String value)

Converts a string into a policy type.

Parameters:

value - is the string to convert.

Returns:

the corresponding endian enum.

value

public static ByteOrder value(int value)

Converts an int into a policy type.

Parameters:

value - the int to convert.

Returns:

the corresponding endian enum.

systemByteOrder

public static ByteOrder systemByteOrder()

Obtains the byte order of the byte order of the system.

Returns:

one of the defined byte order constants.