agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class EndianBitConverter

java.lang.Object

agi.foundation.infrastructure.EndianBitConverter

public final class EndianBitConverter
extends Object

BitConverter assumes that the byte arrays given to it are always in the system's native byte order. If you want to convert bytes that come from a file that is always in the same byte order regardless of the system's endianness, this class will do the byte reordering for you.

Method Summary

Modifier and Type	Method and Description
void	fromDouble(double value, byte[] bytes, int startIndex) Converts the specified double-precision floating point value and stores the bytes in the given array.
void	fromInt16(short value, byte[] bytes, int startIndex) Converts the specified 16-bit signed integer value and stores the bytes in the given array.
void	fromInt32(int value, byte[] bytes, int startIndex) Converts the specified 32-bit signed integer value and stores the bytes in the given array.
void	fromInt64(long value, byte[] bytes, int startIndex) Converts the specified 64-bit signed integer value and stores the bytes in the given array.
void	fromUInt16(int value, byte[] bytes, int startIndex) Converts the specified 16-bit unsigned integer value and stores the bytes in the given array.
void	fromUInt32(long value, byte[] bytes, int startIndex) Converts the specified 32-bit unsigned integer value and stores the bytes in the given array.
static EndianBitConverter	getBigEndian() Gets an EndianBitConverter that assumes all bytes are in Big Endian byte order.
byte[]	getBytes(double value) Returns the specified double-precision floating point value as an array of bytes.
byte[]	getBytes(float value) Returns the specified single-precision floating point value as an array of bytes.
byte[]	getBytes(int value) Returns the specified 32-bit signed integer value as an array of bytes.
byte[]	getBytes(long value) Returns the specified 64-bit signed integer value as an array of bytes.
byte[]	getBytes(short value) Returns the specified 16-bit signed integer value as an array of bytes.
static EndianBitConverter	getLittleEndian() Gets an EndianBitConverter that assumes all bytes are in Little Endian byte order.
double	toDouble(byte[] value, int startIndex) Returns a double-precision floating point number converted from eight bytes at a specified position in a byte array.
short	toInt16(byte[] value, int startIndex) Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.
int	toInt32(byte[] value, int startIndex) Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.
long	toInt64(byte[] value, int startIndex) Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.
float	toSingle(byte[] value, int startIndex) Returns a single-precision floating point number converted from four bytes at a specified position in a byte array.
int	toUInt16(byte[] value, int startIndex) Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.
long	toUInt32(byte[] value, int startIndex) Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLittleEndian

@Nonnull
public static EndianBitConverter getLittleEndian()

Gets an EndianBitConverter that assumes all bytes are in Little Endian byte order.

getBigEndian

@Nonnull
public static EndianBitConverter getBigEndian()

Gets an EndianBitConverter that assumes all bytes are in Big Endian byte order.

toInt16

public final short toInt16(@Nonnull
                           byte[] value,
                           int startIndex)

Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A 16-bit signed integer formed by two bytes beginning at startIndex.

getBytes

@Nonnull
public final byte[] getBytes(short value)

Returns the specified 16-bit signed integer value as an array of bytes.

Parameters:

value - The number to convert.

Returns:

An array of bytes with length 2.

fromInt16

public final void fromInt16(short value,
                            @Nonnull
                            byte[] bytes,
                            int startIndex)

Converts the specified 16-bit signed integer value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.

toUInt16

public final int toUInt16(@Nonnull
                          byte[] value,
                          int startIndex)

Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A 16-bit unsigned integer formed by two bytes beginning at startIndex.

fromUInt16

public final void fromUInt16(int value,
                             @Nonnull
                             byte[] bytes,
                             int startIndex)

Converts the specified 16-bit unsigned integer value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.

toInt32

public final int toInt32(@Nonnull
                         byte[] value,
                         int startIndex)

Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A 32-bit signed integer formed by four bytes beginning at startIndex.

getBytes

@Nonnull
public final byte[] getBytes(int value)

Returns the specified 32-bit signed integer value as an array of bytes.

Parameters:

value - The number to convert.

Returns:

An array of bytes with length 4.

fromInt32

public final void fromInt32(int value,
                            @Nonnull
                            byte[] bytes,
                            int startIndex)

Converts the specified 32-bit signed integer value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.

toUInt32

public final long toUInt32(@Nonnull
                           byte[] value,
                           int startIndex)

Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A 32-bit unsigned integer formed by four bytes beginning at startIndex.

fromUInt32

public final void fromUInt32(long value,
                             @Nonnull
                             byte[] bytes,
                             int startIndex)

Converts the specified 32-bit unsigned integer value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.

toSingle

public final float toSingle(@Nonnull
                            byte[] value,
                            int startIndex)

Returns a single-precision floating point number converted from four bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A single precision floating point number formed by four bytes beginning at startIndex.

getBytes

@Nonnull
public final byte[] getBytes(float value)

Returns the specified single-precision floating point value as an array of bytes.

Parameters:

value - The number to convert.

Returns:

An array of bytes with length 4.

toDouble

public final double toDouble(@Nonnull
                             byte[] value,
                             int startIndex)

Returns a double-precision floating point number converted from eight bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A double precision floating point number formed by eight bytes beginning at startIndex.

getBytes

@Nonnull
public final byte[] getBytes(double value)

Returns the specified double-precision floating point value as an array of bytes.

Parameters:

value - The number to convert.

Returns:

An array of bytes with length 8.

fromDouble

public final void fromDouble(double value,
                             @Nonnull
                             byte[] bytes,
                             int startIndex)

Converts the specified double-precision floating point value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.

toInt64

public final long toInt64(@Nonnull
                          byte[] value,
                          int startIndex)

Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.

Parameters:

value - An array of bytes.

startIndex - The starting position within value.

Returns:

A 64-bit signed integer formed by eight bytes beginning at startIndex.

getBytes

@Nonnull
public final byte[] getBytes(long value)

Returns the specified 64-bit signed integer value as an array of bytes.

Parameters:

value - The number to convert.

Returns:

An array of bytes with length 8.

fromInt64

public final void fromInt64(long value,
                            @Nonnull
                            byte[] bytes,
                            int startIndex)

Converts the specified 64-bit signed integer value and stores the bytes in the given array.

Parameters:

value - The number to convert.

bytes - An array of bytes.

startIndex - The starting position within bytes.