Modifier and Type	Class and Description
public static class	BinaryOutput.ByteArrayBinaryOutput A `BinaryOutput` backed by a byte array.
public static class	BinaryOutput.CCharPointerBinaryOutput A `BinaryOutput` backed by an off-heap memory.

Modifier and Type	Field and Description
pack-priv static final byte	ARRAY
pack-priv static final byte	BOOLEAN
pack-priv static final byte	BYTE
pack-priv static final byte	CHAR
pack-priv static final byte	DOUBLE
pack-priv static final byte	FLOAT
pack-priv static final byte	INT
pack-priv static final int	LARGE_STRING_TAG Tag to distinguish between long and short string.
pack-priv static final byte	LONG
private static final int	MAX_LENGTH Maximum string length for string encoded by 4 bytes length followed be content.
private static final int	MAX_SHORT_LENGTH Maximum string length for string encoded by 2 bytes length followed be content.
pack-priv static final byte	NULL
protected int	pos
pack-priv static final byte	SHORT
pack-priv static final byte	STRING
private byte[]	tempDecodingBuffer

Access	Constructor and Description
private	BinaryOutput()

Method Summary

Modifier and Type	Method and Description
pack-priv static int	bufferSize(int headerSize, int dataSize)
public static BinaryOutput.ByteArrayBinaryOutput	create() Creates a new buffer backed by a byte array.
public static BinaryOutput.ByteArrayBinaryOutput	create(byte[] initialBuffer) Creates a new buffer wrapping the `initialBuffer`.
public static BinaryOutput.CCharPointerBinaryOutput	create(CCharPointer the off-heap memory address address, int the off-heap memory size length, boolean `true` if the memory was dynamically allocated and should be freed when the buffer is closed; `false` for the stack allocated memory. dynamicallyAllocated) Creates a new buffer wrapping an off-heap memory segment starting at `address` having `length` bytes.
private void	ensureBufferSize(int headerSize, int dataSize)
public int	getPosition() Returns this buffer's position.
public static boolean	isTypedValue(Object value) Returns `true` if a value is a typed value writable using `writeTypedValue(Object)`, else `false`.
public abstract void	skip(int number of bytes to reserve. numberOfBytes) Reserves a buffer space.
public abstract void	write(int b) Writes the lowest byte of the argument as a single byte value.
public abstract void	write(byte[] array, int off, int len) Writes `len` bytes from the byte `array` starting at offset `off`.
public final void	write(boolean[] array, int off, int len) Writes `len` bytes from the boolean `array` starting at offset `off`.
public final void	write(short[] array, int off, int len) Writes `len` shorts from the `array` starting at offset `off`.
public final void	write(char[] array, int off, int len) Writes `len` chars from the `array` starting at offset `off`.
public final void	write(int[] array, int off, int len) Writes `len` ints from the `array` starting at offset `off`.
public final void	write(long[] array, int off, int len) Writes `len` longs from the `array` starting at offset `off`.
public final void	write(float[] array, int off, int len) Writes `len` floats from the `array` starting at offset `off`.
public final void	write(double[] array, int off, int len) Writes `len` doubles from the `array` starting at offset `off`.
public final void	writeBoolean(boolean value) Writes a `boolean` as a single byte value.
public final void	writeByte(int value) Writes a `byte` as a single byte value.
public final void	writeChar(int value) Writes a `char` as two bytes, high byte first.
public final void	writeDouble(double value) Converts a `double` value to a `long` using the `Double#doubleToLongBits(double)`, and then writes that `long` as eight bytes, high byte first.
public final void	writeFloat(float value) Converts a `float` value to an `int` using the `Float#floatToIntBits(float)`, and then writes that `int` as four bytes, high byte first.
public final void	writeInt(int value) Writes an `int` as four bytes, high byte first.
public final void	writeLong(long value) Writes a `long` as eight bytes, high byte first.
public final void	writeShort(int value) Writes a `short` as two bytes, high byte first.
public final void	writeTypedValue(Object value) Writes the value that is represented by the given object, together with information on the value's data type.
public final void	writeUTF(String string) Writes a string using a modified UTF-8 encoding in a machine-independent manner.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ARRAY	back to summary
pack-priv static final byte ARRAY

BOOLEAN	back to summary
pack-priv static final byte BOOLEAN

BYTE	back to summary
pack-priv static final byte BYTE

CHAR	back to summary
pack-priv static final byte CHAR

DOUBLE	back to summary
pack-priv static final byte DOUBLE

FLOAT	back to summary
pack-priv static final byte FLOAT

INT	back to summary
pack-priv static final byte INT

LARGE_STRING_TAG	back to summary
pack-priv static final int LARGE_STRING_TAG Tag to distinguish between long and short string. The tag is set in the first string length byte.

LONG	back to summary
pack-priv static final byte LONG

MAX_LENGTH	back to summary
private static final int MAX_LENGTH Maximum string length for string encoded by 4 bytes length followed be content.

MAX_SHORT_LENGTH	back to summary
private static final int MAX_SHORT_LENGTH Maximum string length for string encoded by 2 bytes length followed be content.

NULL	back to summary
pack-priv static final byte NULL

pos	back to summary
protected int pos

SHORT	back to summary
pack-priv static final byte SHORT

STRING	back to summary
pack-priv static final byte STRING

tempDecodingBuffer	back to summary
private byte[] tempDecodingBuffer

Constructor Detail

BinaryOutput	back to summary
private BinaryOutput()

Method Detail

bufferSize	back to summary
pack-priv static int bufferSize(int headerSize, int dataSize)

create	back to summary
public static BinaryOutput.ByteArrayBinaryOutput create() Creates a new buffer backed by a byte array.

create	back to summary
public static BinaryOutput.ByteArrayBinaryOutput create(byte[] initialBuffer) Creates a new buffer wrapping the `initialBuffer`. If the `initialBuffer` capacity is not sufficient for writing the data, a new array is allocated. Always use `ByteArrayBinaryOutput#getArray()` to obtain the marshaled data.

create back to summary

create	back to summary
public static BinaryOutput.CCharPointerBinaryOutput create(CCharPointer address, int length, boolean dynamicallyAllocated) Creates a new buffer wrapping an off-heap memory segment starting at `address` having `length` bytes. If the capacity of an off-heap memory segment is not sufficient for writing the data, a new off-heap memory is allocated. Always use `CCharPointerBinaryOutput#getAddress()` to obtain the marshaled data. Parameters address:CCharPointer the off-heap memory address length:int the off-heap memory size dynamicallyAllocated:boolean `true` if the memory was dynamically allocated and should be freed when the buffer is closed; `false` for the stack allocated memory.

public static BinaryOutput.CCharPointerBinaryOutput create(CCharPointer address, int length, boolean dynamicallyAllocated)

Creates a new buffer wrapping an off-heap memory segment starting at address having length bytes. If the capacity of an off-heap memory segment is not sufficient for writing the data, a new off-heap memory is allocated. Always use CCharPointerBinaryOutput#getAddress() to obtain the marshaled data.

Parameters

address:CCharPointer: the off-heap memory address
length:int: the off-heap memory size
dynamicallyAllocated:boolean: true if the memory was dynamically allocated and should be freed when the buffer is closed; false for the stack allocated memory.

ensureBufferSize	back to summary
private void ensureBufferSize(int headerSize, int dataSize)

getPosition	back to summary
public int getPosition() Returns this buffer's position.

isTypedValue	back to summary
public static boolean isTypedValue(Object value) Returns `true` if a value is a typed value writable using `writeTypedValue(Object)`, else `false`.

skip	back to summary
public abstract void skip(int numberOfBytes) Reserves a buffer space. The reserved space can be used for out parameters. Parameters numberOfBytes:int number of bytes to reserve.

skip

back to summary

public abstract void skip(int numberOfBytes)

Reserves a buffer space. The reserved space can be used for out parameters.

Parameters

numberOfBytes:int: number of bytes to reserve.

write	back to summary
public abstract void write(int b) Writes the lowest byte of the argument as a single byte value. The buffer position is incremented by `1`.

write	back to summary
public abstract void write(byte[] array, int off, int len) Writes `len` bytes from the byte `array` starting at offset `off`. The buffer position is incremented by `len`.

write	back to summary
public final void write(boolean[] array, int off, int len) Writes `len` bytes from the boolean `array` starting at offset `off`. The value `true` is written as the value `(byte)1`, the value `false` is written as the value `(byte)0`. The buffer position is incremented by `len`.

write	back to summary
public final void write(short[] array, int off, int len) Writes `len` shorts from the `array` starting at offset `off`. The buffer position is incremented by `2 * len`.

write	back to summary
public final void write(char[] array, int off, int len) Writes `len` chars from the `array` starting at offset `off`. The buffer position is incremented by `2 * len`.

write	back to summary
public final void write(int[] array, int off, int len) Writes `len` ints from the `array` starting at offset `off`. The buffer position is incremented by `4 * len`.

write	back to summary
public final void write(long[] array, int off, int len) Writes `len` longs from the `array` starting at offset `off`. The buffer position is incremented by `8 * len`.

write	back to summary
public final void write(float[] array, int off, int len) Writes `len` floats from the `array` starting at offset `off`. Each `float` value is converted to an `int` using the `Float#floatToIntBits(float)` and written as an int. The buffer position is incremented by `4 * len`.

write	back to summary
public final void write(double[] array, int off, int len) Writes `len` doubles from the `array` starting at offset `off`. Each `double` value is converted to an `lang` using the `Double#doubleToLongBits(double)` and written as a long. The buffer position is incremented by `8 * len`.

writeBoolean	back to summary
public final void writeBoolean(boolean value) Writes a `boolean` as a single byte value. The value `true` is written as the value `(byte)1`, the value `false` is written as the value `(byte)0`. The buffer position is incremented by `1`.

writeByte	back to summary
public final void writeByte(int value) Writes a `byte` as a single byte value. The buffer position is incremented by `1`.

writeChar	back to summary
public final void writeChar(int value) Writes a `char` as two bytes, high byte first. The buffer position is incremented by `2`.

writeDouble	back to summary
public final void writeDouble(double value) Converts a `double` value to a `long` using the `Double#doubleToLongBits(double)`, and then writes that `long` as eight bytes, high byte first. The buffer position is incremented by `8`.

writeFloat	back to summary
public final void writeFloat(float value) Converts a `float` value to an `int` using the `Float#floatToIntBits(float)`, and then writes that `int` as four bytes, high byte first. The buffer position is incremented by `4`.

writeInt	back to summary
public final void writeInt(int value) Writes an `int` as four bytes, high byte first. The buffer position is incremented by `4`.

writeLong	back to summary
public final void writeLong(long value) Writes a `long` as eight bytes, high byte first. The buffer position is incremented by `8`.

writeShort	back to summary
public final void writeShort(int value) Writes a `short` as two bytes, high byte first. The buffer position is incremented by `2`.

writeTypedValue back to summary

writeTypedValue	back to summary
public final void writeTypedValue(Object value) throws IllegalArgumentException Writes the value that is represented by the given object, together with information on the value's data type. Supported types are boxed Java primitive types, `String`, `null`, and arrays of these types. Exceptions IllegalArgumentException: when the `value` type is not supported or the `value` is a string which cannot be encoded using modified UTF-8 encoding. See Also `to find out whether a value can be serialized.`

public final void writeTypedValue(Object value) throws IllegalArgumentException

Writes the value that is represented by the given object, together with information on the value's data type. Supported types are boxed Java primitive types, String, null, and arrays of these types.

Exceptions

IllegalArgumentException:: when the value type is not supported or the value is a string which cannot be encoded using modified UTF-8 encoding.

writeUTF back to summary

writeUTF	back to summary
public final void writeUTF(String string) throws IllegalArgumentException Writes a string using a modified UTF-8 encoding in a machine-independent manner. Exceptions IllegalArgumentException: if the `string` cannot be encoded using modified UTF-8 encoding.

public final void writeUTF(String string) throws IllegalArgumentException

Writes a string using a modified UTF-8 encoding in a machine-independent manner.

Exceptions

IllegalArgumentException:: if the string cannot be encoded using modified UTF-8 encoding.

org.graalvm.nativebridge back to summary

public final Class BinaryOutput.ByteArrayBinaryOutput

Class Inheritance

extends BinaryOutput

java.lang.Object
org.graalvm.nativebridge.BinaryOutput
org.graalvm.nativebridge.BinaryOutput.ByteArrayBinaryOutput

A BinaryOutput backed by a byte array.

Field Summary

Modifier and Type	Field and Description
private byte[]	buffer
pack-priv static final int	INITIAL_SIZE
private static final int	MAX_ARRAY_SIZE

Inherited from org.graalvm.nativebridge.BinaryOutput:: ARRAY BOOLEAN BYTE CHAR DOUBLE FLOAT INT LARGE_STRING_TAG LONG NULL pos SHORT STRING

Constructor Summary

Access	Constructor and Description
private	ByteArrayBinaryOutput(int size)
private	ByteArrayBinaryOutput(byte[] initialBuffer)

Method Summary

Modifier and Type	Method and Description
public static BinaryOutput.ByteArrayBinaryOutput	create(int initialSize) Creates a new buffer backed by a byte array.
private void	ensureCapacity(int neededCapacity)
public byte[]	getArray() Returns the byte array containing the marshalled data.
public void	skip(int number of bytes to reserve. numberOfBytes) Implements abstract org.graalvm.nativebridge.BinaryOutput.skip. Reserves a buffer space.
public void	write(int b) Implements abstract org.graalvm.nativebridge.BinaryOutput.write. Writes the lowest byte of the argument as a single byte value.
public void	write(byte[] b, int off, int len) Implements abstract org.graalvm.nativebridge.BinaryOutput.write. Writes `len` bytes from the byte `array` starting at offset `off`.

Field Detail

buffer	back to summary
private byte[] buffer

INITIAL_SIZE	back to summary
pack-priv static final int INITIAL_SIZE

MAX_ARRAY_SIZE	back to summary
private static final int MAX_ARRAY_SIZE

Constructor Detail

ByteArrayBinaryOutput	back to summary
private ByteArrayBinaryOutput(int size)

ByteArrayBinaryOutput	back to summary
private ByteArrayBinaryOutput(byte[] initialBuffer)

Method Detail

create	back to summary
public static BinaryOutput.ByteArrayBinaryOutput create(int initialSize) Creates a new buffer backed by a byte array. The buffer initial size is `initialSize`.

ensureCapacity	back to summary
private void ensureCapacity(int neededCapacity)

getArray	back to summary
public byte[] getArray() Returns the byte array containing the marshalled data.

skip

back to summary

public void skip(int numberOfBytes)

Implements abstract org.graalvm.nativebridge.BinaryOutput.skip.

Doc from org.graalvm.nativebridge.BinaryOutput.skip.

Reserves a buffer space. The reserved space can be used for out parameters.

Parameters

numberOfBytes:int: number of bytes to reserve.

Annotations

@Override

write back to summary

public void write(int b)

Implements abstract org.graalvm.nativebridge.BinaryOutput.write.

Doc from org.graalvm.nativebridge.BinaryOutput.write.

Writes the lowest byte of the argument as a single byte value. The buffer position is incremented by 1.

Annotations

@Override

write back to summary

public void write(byte[] b, int off, int len)

Implements abstract org.graalvm.nativebridge.BinaryOutput.write.

Doc from org.graalvm.nativebridge.BinaryOutput.write.

Writes len bytes from the byte array starting at offset off. The buffer position is incremented by len.

Annotations

@Override

org.graalvm.nativebridge back to summary

public final Class BinaryOutput.CCharPointerBinaryOutput

Class Inheritance

extends BinaryOutput
implements Closeable

java.lang.Object
org.graalvm.nativebridge.BinaryOutput
org.graalvm.nativebridge.BinaryOutput.CCharPointerBinaryOutput

All Implemented Interfaces

java.io.Closeable, java.lang.AutoCloseable

A BinaryOutput backed by an off-heap memory.

Field Summary

Modifier and Type	Field and Description
private CCharPointer	address
private static final int	BYTEBUFFER_COPY_FROM_ARRAY_THRESHOLD Represents the point at which the average cost of a JNI call exceeds the expense of an element by element copy.
private ByteBuffer	byteBufferView ByteBuffer view of this `CCharPointerBinaryOutput` direct memory.
private int	length
private boolean	unmanaged

Inherited from org.graalvm.nativebridge.BinaryOutput:: ARRAY BOOLEAN BYTE CHAR DOUBLE FLOAT INT LARGE_STRING_TAG LONG NULL pos SHORT STRING

Constructor Summary

Access	Constructor and Description
private	CCharPointerBinaryOutput(CCharPointer address, int length, boolean unmanaged)

Method Summary

Modifier and Type	Method and Description
private void	checkClosed()
public void	close() Implements java.io.Closeable.close. Closes the buffer and frees off-heap allocated resources.
public static BinaryOutput.CCharPointerBinaryOutput	create(int initialSize) Creates a new buffer backed by an off-heap memory segment.
private void	ensureCapacity(int neededCapacity)
public CCharPointer	getAddress() Returns an address of an off-heap memory segment containing the marshalled data.
public int	getPosition() Overrides org.graalvm.nativebridge.BinaryOutput.getPosition. Returns this buffer's position.
private static void	memcpy(CCharPointer dst, CCharPointer src, int len)
public void	skip(int number of bytes to reserve. numberOfBytes) Implements abstract org.graalvm.nativebridge.BinaryOutput.skip. Reserves a buffer space.
public void	write(int b) Implements abstract org.graalvm.nativebridge.BinaryOutput.write. Writes the lowest byte of the argument as a single byte value.
public void	write(byte[] b, int off, int len) Implements abstract org.graalvm.nativebridge.BinaryOutput.write. Writes `len` bytes from the byte `array` starting at offset `off`.

Field Detail

address	back to summary
private CCharPointer address

BYTEBUFFER_COPY_FROM_ARRAY_THRESHOLD	back to summary
private static final int BYTEBUFFER_COPY_FROM_ARRAY_THRESHOLD Represents the point at which the average cost of a JNI call exceeds the expense of an element by element copy. See `java.nio.Bits#JNI_COPY_FROM_ARRAY_THRESHOLD`.

byteBufferView	back to summary
private ByteBuffer byteBufferView ByteBuffer view of this `CCharPointerBinaryOutput` direct memory. The ByteBuffer is used for bulk data transfers, where the bulk ByteBuffer operations outperform element by element copying by an order of magnitude.

length	back to summary
private int length

unmanaged	back to summary
private boolean unmanaged

Constructor Detail

CCharPointerBinaryOutput	back to summary
private CCharPointerBinaryOutput(CCharPointer address, int length, boolean unmanaged)

Method Detail

checkClosed	back to summary
private void checkClosed()

back to summary

public void close()

Implements java.io.Closeable.close.

Closes the buffer and frees off-heap allocated resources.

Annotations

@Override

create	back to summary
public static BinaryOutput.CCharPointerBinaryOutput create(int initialSize) Creates a new buffer backed by an off-heap memory segment. The buffer initial size is `initialSize`.