com.oracle.truffle.api.memory

Class ByteArraySupport

java.lang.Object

com.oracle.truffle.api.memory.ByteArraySupport

public abstract class ByteArraySupport
extends Object

Utility methods to write to and read from arrays of bytes. Singletons of this class are obtained from ByteArraySupport.littleEndian() or ByteArraySupport.bigEndian() respectively to access byte arrays in little-endian or big-endian order.

Thread safety

The methods of this class are not safe for use by multiple concurrent threads. If a byte array is to be used by more than one thread then access to the byte array should be controlled by appropriate synchronization.

Alignment

Unaligned accesses are allowed.

Since:

20.3

Method Summary

Modifier and Type	Method and Description
static ByteArraySupport	bigEndian() Enables accessing multibyte Java primitives from byte arrays in big-endian order.
abstract byte	getByte(byte[] buffer, int byteOffset) Reads the byte at the given byte offset from the start of the buffer.
abstract byte	getByte(byte[] buffer, long byteOffset) Reads the byte at the given byte offset from the start of the buffer.
abstract double	getDouble(byte[] buffer, int byteOffset) Reads the double at the given byte offset from the start of the buffer.
abstract double	getDouble(byte[] buffer, long byteOffset) Reads the double at the given byte offset from the start of the buffer.
abstract float	getFloat(byte[] buffer, int byteOffset) Reads the float at the given byte offset from the start of the buffer.
abstract float	getFloat(byte[] buffer, long byteOffset) Reads the float at the given byte offset from the start of the buffer.
abstract int	getInt(byte[] buffer, int byteOffset) Reads the int at the given byte offset from the start of the buffer.
abstract int	getInt(byte[] buffer, long byteOffset) Reads the int at the given byte offset from the start of the buffer.
abstract long	getLong(byte[] buffer, int byteOffset) Reads the long at the given byte offset from the start of the buffer.
abstract long	getLong(byte[] buffer, long byteOffset) Reads the long at the given byte offset from the start of the buffer.
abstract short	getShort(byte[] buffer, int byteOffset) Reads the short at the given byte offset from the start of the buffer.
abstract short	getShort(byte[] buffer, long byteOffset) Reads the short at the given byte offset from the start of the buffer.
boolean	inBounds(byte[] buffer, int startByteOffset, int length) Checks if an access is in bounds of the given buffer.
boolean	inBounds(byte[] buffer, long startByteOffset, long length) Checks if an access is in bounds of the given buffer.
static ByteArraySupport	littleEndian() Enables accessing multibyte Java primitives from byte arrays in little-endian order.
abstract void	putByte(byte[] buffer, int byteOffset, byte value) Writes the given byte at the given byte offset from the start of the buffer.
abstract void	putByte(byte[] buffer, long byteOffset, byte value) Writes the given byte at the given byte offset from the start of the buffer.
abstract void	putDouble(byte[] buffer, int byteOffset, double value) Writes the given double at the given byte offset from the start of the buffer.
abstract void	putDouble(byte[] buffer, long byteOffset, double value) Writes the given double at the given byte offset from the start of the buffer.
abstract void	putFloat(byte[] buffer, int byteOffset, float value) Writes the given float at the given byte offset from the start of the buffer.
abstract void	putFloat(byte[] buffer, long byteOffset, float value) Writes the given float at the given byte offset from the start of the buffer.
abstract void	putInt(byte[] buffer, int byteOffset, int value) Writes the given int at the given byte offset from the start of the buffer.
abstract void	putInt(byte[] buffer, long byteOffset, int value) Writes the given int at the given byte offset from the start of the buffer.
abstract void	putLong(byte[] buffer, int byteOffset, long value) Writes the given long at the given byte offset from the start of the buffer.
abstract void	putLong(byte[] buffer, long byteOffset, long value) Writes the given long at the given byte offset from the start of the buffer.
abstract void	putShort(byte[] buffer, int byteOffset, short value) Writes the given short at the given byte offset from the start of the buffer.
abstract void	putShort(byte[] buffer, long byteOffset, short value) Writes the given short at the given byte offset from the start of the buffer.

Methods inherited from class java.lang.Object

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

Method Detail

littleEndian

public static ByteArraySupport littleEndian()

Enables accessing multibyte Java primitives from byte arrays in little-endian order.

Example usage:

 byte[] buffer = new byte[]{0, 0, 0, 0};
 ByteArraySupport.littleEndian().putShort(buffer, 2, (short) 1);
 // buffer[2] == (byte) 1
 // buffer[3] == (byte) 0
 ByteArraySupport.littleEndian().putShort(buffer, 3, (short) 1);
 // throws IndexOutOfBoundsException exception
 

Since:

20.3

bigEndian

public static ByteArraySupport bigEndian()

Enables accessing multibyte Java primitives from byte arrays in big-endian order.

Example usage:

 byte[] buffer = new byte[]{0, 0, 0, 0};
 ByteArraySupport.bigEndian().putShort(buffer, 0, (short) 1);
 // buffer[0] == (byte) 0
 // buffer[1] == (byte) 1
 

Since:

20.3

inBounds

public final boolean inBounds(byte[] buffer,
                              int startByteOffset,
                              int length)

Checks if an access is in bounds of the given buffer.

If out-of-bounds accesses are expected to happen frequently, it is faster (~1.2x in interpreter mode) to use this method to check for them than catching IndexOutOfBoundsExceptions.

Parameters:

buffer - the byte array

startByteOffset - the start byte offset of the access

length - the number of bytes accessed

Returns:

True if the access is in bounds, false otherwise

Since:

20.3

inBounds

public final boolean inBounds(byte[] buffer,
                              long startByteOffset,
                              long length)

Checks if an access is in bounds of the given buffer.

If out-of-bounds accesses are expected to happen frequently, it is faster (~1.2x in interpreter mode) to use this method to check for them than catching IndexOutOfBoundsExceptions.

Parameters:

buffer - the byte array

startByteOffset - the start byte offset of the access

length - the number of bytes accessed

Returns:

True if the access is in bounds, false otherwise

Since:

22.2

getByte

public abstract byte getByte(byte[] buffer,
                             int byteOffset)
                      throws IndexOutOfBoundsException

Reads the byte at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset at which the byte will be read

Returns:

the byte at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length

Since:

20.3

getByte

public abstract byte getByte(byte[] buffer,
                             long byteOffset)
                      throws IndexOutOfBoundsException

Reads the byte at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset at which the byte will be read

Returns:

the byte at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length

Since:

22.2

putByte

public abstract void putByte(byte[] buffer,
                             int byteOffset,
                             byte value)
                      throws IndexOutOfBoundsException

Writes the given byte at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset at which the byte will be written

value - the byte value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length

Since:

20.3

putByte

public abstract void putByte(byte[] buffer,
                             long byteOffset,
                             byte value)
                      throws IndexOutOfBoundsException

Writes the given byte at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset at which the byte will be written

value - the byte value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length

Since:

22.2

getShort

public abstract short getShort(byte[] buffer,
                               int byteOffset)
                        throws IndexOutOfBoundsException

Reads the short at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the short will be read

Returns:

the short at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 1

Since:

20.3

getShort

public abstract short getShort(byte[] buffer,
                               long byteOffset)
                        throws IndexOutOfBoundsException

Reads the short at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the short will be read

Returns:

the short at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 1

Since:

22.2

putShort

public abstract void putShort(byte[] buffer,
                              int byteOffset,
                              short value)
                       throws IndexOutOfBoundsException

Writes the given short at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the short will be written

value - the short value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 1

Since:

20.3

putShort

public abstract void putShort(byte[] buffer,
                              long byteOffset,
                              short value)
                       throws IndexOutOfBoundsException

Writes the given short at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the short will be written

value - the short value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 1

Since:

22.2

getInt

public abstract int getInt(byte[] buffer,
                           int byteOffset)
                    throws IndexOutOfBoundsException

Reads the int at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the int will be read

Returns:

the int at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

20.3

getInt

public abstract int getInt(byte[] buffer,
                           long byteOffset)
                    throws IndexOutOfBoundsException

Reads the int at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the int will be read

Returns:

the int at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

20.3

putInt

public abstract void putInt(byte[] buffer,
                            int byteOffset,
                            int value)
                     throws IndexOutOfBoundsException

Writes the given int at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the int will be written

value - the int value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

20.3

putInt

public abstract void putInt(byte[] buffer,
                            long byteOffset,
                            int value)
                     throws IndexOutOfBoundsException

Writes the given int at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the int will be written

value - the int value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

22.2

getLong

public abstract long getLong(byte[] buffer,
                             int byteOffset)
                      throws IndexOutOfBoundsException

Reads the long at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the int will be read

Returns:

the int at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

20.3

getLong

public abstract long getLong(byte[] buffer,
                             long byteOffset)
                      throws IndexOutOfBoundsException

Reads the long at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the int will be read

Returns:

the int at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

22.2

putLong

public abstract void putLong(byte[] buffer,
                             int byteOffset,
                             long value)
                      throws IndexOutOfBoundsException

Writes the given long at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the int will be written

value - the int value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

20.3

putLong

public abstract void putLong(byte[] buffer,
                             long byteOffset,
                             long value)
                      throws IndexOutOfBoundsException

Writes the given long at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the int will be written

value - the int value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

22.2

getFloat

public abstract float getFloat(byte[] buffer,
                               int byteOffset)
                        throws IndexOutOfBoundsException

Reads the float at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the float will be read

Returns:

the float at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

20.3

getFloat

public abstract float getFloat(byte[] buffer,
                               long byteOffset)
                        throws IndexOutOfBoundsException

Reads the float at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the float will be read

Returns:

the float at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

22.2

putFloat

public abstract void putFloat(byte[] buffer,
                              int byteOffset,
                              float value)
                       throws IndexOutOfBoundsException

Writes the given float at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the float will be written

value - the float value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

20.3

putFloat

public abstract void putFloat(byte[] buffer,
                              long byteOffset,
                              float value)
                       throws IndexOutOfBoundsException

Writes the given float at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the float will be written

value - the float value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 3

Since:

22.2

getDouble

public abstract double getDouble(byte[] buffer,
                                 int byteOffset)
                          throws IndexOutOfBoundsException

Reads the double at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the double will be read

Returns:

the double at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

20.3

getDouble

public abstract double getDouble(byte[] buffer,
                                 long byteOffset)
                          throws IndexOutOfBoundsException

Reads the double at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to read from

byteOffset - the byte offset from which the double will be read

Returns:

the double at the given byte offset from the start of the buffer

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

22.2

putDouble

public abstract void putDouble(byte[] buffer,
                               int byteOffset,
                               double value)
                        throws IndexOutOfBoundsException

Writes the given double at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the double will be written

value - the double value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

20.3

putDouble

public abstract void putDouble(byte[] buffer,
                               long byteOffset,
                               double value)
                        throws IndexOutOfBoundsException

Writes the given double at the given byte offset from the start of the buffer.

Parameters:

buffer - the byte array to write in

byteOffset - the byte offset from which the double will be written

value - the double value to be written

Throws:

IndexOutOfBoundsException - if and only if byteOffset < 0 || byteOffset >= buffer.length - 7

Since:

22.2