Interface BinaryMarshaller<T>

public interface BinaryMarshaller<T>

A marshaller used by the native bridge processor to read or write method parameters and results of a custom type. Marshallers are used to support types that are not directly implemented by the native bridge processor.

See Also:

• JNIConfig.Builder

Method Summary

Modifier and Type	Method	Description
default int	inferSize(T object)	Estimates a size in bytes needed to marshall given object.
default int	inferUpdateSize(T object)	Estimates a size in bytes needed to marshall Out parameter passed back to caller from a foreign method call.
static <T> BinaryMarshaller<T>	nullable(BinaryMarshaller<T> forMarshaller)	Decorates forMarshaller by a BinaryMarshaller handling null values.
T	read(BinaryInput input)	Deserializes and recreates an object passed to a foreign method.
default void	readUpdate(BinaryInput input, T object)	Deserializes and updates the mutable state of a given object to support Out semantics.
void	write(BinaryOutput output, T object)	Decomposes and serializes the given object passed to a foreign method.
default void	writeUpdate(BinaryOutput output, T object)	Decomposes and serializes the mutable state of a given object to support Out semantics.

Method Details

write

void write(BinaryOutput output,
 T object)

Decomposes and serializes the given object passed to a foreign method.

read

T read(BinaryInput input)

Deserializes and recreates an object passed to a foreign method.

inferSize

default int inferSize(T object)

Estimates a size in bytes needed to marshall given object. The returned value is used to pre-allocate the BinaryOutput's buffer. The accuracy of the estimate affects the speed of marshalling. If the estimate is too small, the pre-allocated buffer must be re-allocated and the already marshalled data must be copied. Too large a value may cause the static buffer to be unused and the dynamic buffer to be unnecessarily allocated.

writeUpdate

default void writeUpdate(BinaryOutput output,
 T object)

Decomposes and serializes the mutable state of a given object to support Out semantics. Marshallers that do not support Out parameters do not need to implement this method. The default implementation throws UnsupportedOperationException. To support Out parameters the BinaryMarshaller must implement also readUpdate(BinaryInput, Object) and inferUpdateSize(Object).

The Out parameters are passed in the following way:

1. The start point method writes the parameter using write(BinaryOutput, Object).
2. A foreign method call is made.
3. The end point method reads the parameter using read(BinaryInput).
4. The end point receiver method is called with the unmarshalled parameter.
5. After calling the receiver method, the end point method writes the mutated Out parameter state using writeUpdate(BinaryOutput, Object).
6. A foreign method returns.
7. The state of the Out parameter is updated using readUpdate(BinaryInput, Object).

See Also:

• readUpdate(BinaryInput, Object)
• inferUpdateSize(Object)

readUpdate

default void readUpdate(BinaryInput input,
 T object)

Deserializes and updates the mutable state of a given object to support Out semantics. Marshallers that do not support Out parameters do not need to implement this method. The default implementation throws UnsupportedOperationException. To support Out parameters the BinaryMarshaller must implement also writeUpdate(BinaryOutput, Object) and inferUpdateSize(Object).

See Also:

• writeUpdate(BinaryOutput, Object)
• inferUpdateSize(Object)

inferUpdateSize

default int inferUpdateSize(T object)

Estimates a size in bytes needed to marshall Out parameter passed back to caller from a foreign method call. The accuracy of the estimate affects the speed of marshalling. If the estimate is too small, the pre-allocated buffer must be re-allocated and the already marshalled data must be copied. Too large a value may cause the static buffer to be unused and the dynamic buffer to be unnecessarily allocated. Marshallers that do not support Out parameters do not need to implement this method. The default implementation throws UnsupportedOperationException. To support Out parameters the BinaryMarshaller must implement also writeUpdate(BinaryOutput, Object) and readUpdate(BinaryInput, Object).

See Also:

• writeUpdate(BinaryOutput, Object)
• readUpdate(BinaryInput, Object)

nullable

static <T> BinaryMarshaller<T> nullable(BinaryMarshaller<T> forMarshaller)

Decorates forMarshaller by a BinaryMarshaller handling null values. The returned BinaryMarshaller calls the forMarshaller only non-null values.