Enum Class ByteOrder

java.lang.Object

java.lang.Enum<ByteOrder>

java.nio.ByteOrder

All Implemented Interfaces:

Serializable, Comparable<ByteOrder>, Constable

public enum ByteOrder
extends Enum<ByteOrder>

A typesafe enumeration for byte orders.

Since:

1.4

Nested Class Summary

Nested classes/interfaces declared in class Enum

Enum.EnumDesc<E>

Modifier and Type	Class	Description
static final class	Enum.EnumDesc<E extends Enum<E>>	A nominal descriptor for an enum constant.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BIG_ENDIAN	Constant denoting big-endian byte order.
LITTLE_ENDIAN	Constant denoting little-endian byte order.

Method Summary

Modifier and Type	Method	Description
static ByteOrder	nativeOrder()	Retrieves the native byte order of the underlying platform.
static ByteOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ByteOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods declared in class Enum

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

Modifier and Type	Method	Description
protected final Object	clone()	Throws CloneNotSupportedException.
final int	compareTo(ByteOrder o)	Compares this enum with the specified object for order.
final Optional<Enum.EnumDesc<ByteOrder>>	describeConstable()	Returns an enum descriptor EnumDesc for this instance, if one can be constructed, or an empty Optional if one cannot be.
final boolean	equals(Object other)	Returns true if the specified object is equal to this enum constant.
protected final void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal.
final Class<ByteOrder>	getDeclaringClass()	Returns the Class object corresponding to this enum constant's enum type.
final int	hashCode()	Returns a hash code for this enum constant.
final String	name()	Returns the name of this enum constant, exactly as declared in its enum declaration.
final int	ordinal()	Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
String	toString()	Returns the name of this enum constant, as contained in the declaration.
static <T extends Enum<T>> T	valueOf(Class<T> enumClass, String name)	Returns the enum constant of the specified enum class with the specified name.

Methods declared in class Object

getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
final Class<?>	getClass()	Returns the runtime class of this Object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Enum Constant Details

LITTLE_ENDIAN

public static final ByteOrder LITTLE_ENDIAN

Constant denoting little-endian byte order. In this order, the bytes of a multibyte value are ordered from least significant to most significant.

BIG_ENDIAN

public static final ByteOrder BIG_ENDIAN

Constant denoting big-endian byte order. In this order, the bytes of a multibyte value are ordered from most significant to least significant.

Method Details

values

public static ByteOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ByteOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

nativeOrder

public static ByteOrder nativeOrder()

Retrieves the native byte order of the underlying platform.

This method is defined so that performance-sensitive Java code can allocate direct buffers with the same byte order as the hardware. Native code libraries are often more efficient when such buffers are used.

Returns:

The native byte order of the hardware upon which this Java virtual machine is running