org.graalvm.nativebridge

Class BinaryInput

java.lang.Object

org.graalvm.nativebridge.BinaryInput

public abstract class BinaryInput
extends Object

A buffer used by the BinaryMarshaller to unmarshal parameters and results passed by value.

See Also:

BinaryOutput, BinaryMarshaller, JNIConfig.Builder.registerMarshaller(Class, BinaryMarshaller)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	length
protected int	pos

Method Summary

Modifier and Type	Method and Description
static BinaryInput	create(byte[] buffer) Creates a new buffer backed by a byte array.
static BinaryInput	create(org.graalvm.nativeimage.c.type.CCharPointer address, int length) Creates a new buffer wrapping an off-heap memory segment starting at an address having length bytes.
abstract int	read() Reads a single byte.
abstract int	read(byte[] b, int off, int len) Reads up to len bytes into a byte array starting at offset off.
boolean	readBoolean() Reads a single byte and returns true if that byte is non-zero, false if that byte is zero.
byte	readByte() Reads and returns a single byte.
char	readChar() Reads two bytes and returns a char value.
double	readDouble() Reads eight bytes and returns a double value.
float	readFloat() Reads four bytes and returns a float value.
void	readFully(byte[] b, int off, int len) Reads len bytes into a byte array starting at offset off.
int	readInt() Reads four bytes and returns an int value.
long	readLong() Reads eight bytes and returns a long value.
short	readShort() Reads two bytes and returns a short value.
Object	readTypedValue() Reads a single value, using the data type encoded in the marshalled data.
String	readUTF() Reads a string using a modified UTF-8 encoding in a machine-independent manner.

Methods inherited from class java.lang.Object

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

Field Detail

length

protected final int length

pos

protected int pos

Method Detail

readBoolean

public final boolean readBoolean()
                          throws IndexOutOfBoundsException

Reads a single byte and returns true if that byte is non-zero, false if that byte is zero.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readByte

public final byte readByte()
                    throws IndexOutOfBoundsException

Reads and returns a single byte.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readShort

public final short readShort()
                      throws IndexOutOfBoundsException

Reads two bytes and returns a short value.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readChar

public final char readChar()
                    throws IndexOutOfBoundsException

Reads two bytes and returns a char value.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readInt

public final int readInt()
                  throws IndexOutOfBoundsException

Reads four bytes and returns an int value.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readLong

public final long readLong()
                    throws IndexOutOfBoundsException

Reads eight bytes and returns a long value.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readFloat

public final float readFloat()
                      throws IndexOutOfBoundsException

Reads four bytes and returns a float value. It does this by reading an int value and converting the int value to a float using Float.intBitsToFloat(int).

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

readDouble

public final double readDouble()
                        throws IndexOutOfBoundsException

Reads eight bytes and returns a double value. It does this by reading a long value and converting the long value to a double using Double.longBitsToDouble(long).

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

read

public abstract int read()

Reads a single byte. The byte value is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned.

read

public abstract int read(byte[] b,
                         int off,
                         int len)

Reads up to len bytes into a byte array starting at offset off.

readFully

public final void readFully(byte[] b,
                            int off,
                            int len)
                     throws IndexOutOfBoundsException

Reads len bytes into a byte array starting at offset off.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read

readUTF

public final String readUTF()
                     throws IndexOutOfBoundsException,
                            IllegalArgumentException

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

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

IllegalArgumentException - if the bytes do not represent a valid modified UTF-8 encoding of a string.

readTypedValue

public final Object readTypedValue()
                            throws IndexOutOfBoundsException,
                                   IllegalArgumentException

Reads a single value, using the data type encoded in the marshalled data.

Returns:

The read value, such as a boxed Java primitive, a String, a null, or an array of these types.

Throws:

IndexOutOfBoundsException - if there are not enough bytes to read.

IllegalArgumentException - when the marshaled type is not supported or if the bytes do not represent a valid modified UTF-8 encoding of a string.

create

public static BinaryInput create(byte[] buffer)

Creates a new buffer backed by a byte array.

create

public static BinaryInput create(org.graalvm.nativeimage.c.type.CCharPointer address,
                                 int length)

Creates a new buffer wrapping an off-heap memory segment starting at an address having length bytes.