Package com.aurumsmods.littlebigio

Interface ByteOrdered

All Known Implementing Classes:

BinaryInputStream, BinaryOutputStream

public interface ByteOrdered

An interface for byte order-dependent components, such as IO streams. The ByteOrder value can be retrieved or set to another value. Every class should consist of a single ByteOrder attribute which can be accessed by getOrder() and setOrder(ByteOrder).

It is not allowed that the attribute be null. The developer has to ensure that getOrder() never returns null as well as setOrder(ByteOrder) never sets the attribute to null.

The contract does not prescribe how to work with multithreaded applications.

Method Summary

Modifier and Type	Method	Description
ByteOrder	getOrder()	Returns the ByteOrder.
default boolean	isBigEndian()	Returns true if the byte order is ByteOrder.BIG_ENDIAN.
default boolean	isLittleEndian()	Returns true if the byte order is ByteOrder.LITTLE_ENDIAN.
default boolean	isNativeOrder()	Returns true if the byte order equals the machine's native order.
void	setOrder(ByteOrder byteOrder)	Sets the ByteOrder.
default void	swapOrder()	Swaps the ByteOrder.

Method Details

getOrder

ByteOrder getOrder()

Returns the ByteOrder. This should always return a proper instance, null is not allowed.

Returns:

the ByteOrder.

setOrder

void setOrder(ByteOrder byteOrder)

Sets the ByteOrder. The parameter cannot be null. In that case, a NullPointerException is thrown.

Parameters:

byteOrder - the ByteOrder.

Throws:

NullPointerException - if byteOrder is null.

isBigEndian

default boolean isBigEndian()

Returns true if the byte order is ByteOrder.BIG_ENDIAN. Otherwise, returns false.

Returns:

true if byte order is ByteOrder.BIG_ENDIAN, otherwise false.

isLittleEndian

default boolean isLittleEndian()

Returns true if the byte order is ByteOrder.LITTLE_ENDIAN. Otherwise, returns false.

Returns:

true if byte order is ByteOrder.LITTLE_ENDIAN, otherwise false.

isNativeOrder

default boolean isNativeOrder()

Returns true if the byte order equals the machine's native order. Otherwise, returns false.

Returns:

true if byte order equals the machine's native order.

See Also:

• ByteOrder.nativeOrder()

swapOrder

default void swapOrder()

Swaps the ByteOrder. If it's currently set to ByteOrder.BIG_ENDIAN, it will be changed to ByteOrder.LITTLE_ENDIAN. However, if it's currently set to ByteOrder.LITTLE_ENDIAN, it will be changed to ByteOrder.BIG_ENDIAN.