net.openhft.chronicle.bytes

Interface MethodWriterBuilder<T>

Type Parameters:

T - the type of the MethodWriter that will be built by this builder

All Superinterfaces:

Supplier<T>

public interface MethodWriterBuilder<T>
extends Supplier<T>

Interface for creating a builder that will generate a MethodWriter instance of a specific type. A MethodWriter is used to write methods into a binary stream.

Method Summary

Modifier and Type	Method and Description
default T	build() Builds the MethodWriter instance.
MethodWriterBuilder<T>	genericEvent(String genericEvent) Specifies the identifier for generic events.
default MethodWriterBuilder<T>	metaData(boolean metaData) Controls whether metadata should be included in the binary stream.
MethodWriterBuilder<T>	onClose(net.openhft.chronicle.core.io.Closeable closeable) Specifies a Closeable that should be invoked when the MethodWriter is closed.
default MethodWriterBuilder<T>	updateInterceptor(UpdateInterceptor updateInterceptor) Specifies an UpdateInterceptor for the MethodWriter.
default MethodWriterBuilder<T>	verboseTypes(boolean verboseTypes) Controls whether type information should be included in a verbose manner.

Methods inherited from interface java.util.function.Supplier

get

Method Detail

genericEvent

MethodWriterBuilder<T> genericEvent(String genericEvent)

Specifies the identifier for generic events. A generic event employs the first argument as the method name, providing a flexible way to write arbitrary methods at runtime.

Parameters:

genericEvent - the identifier used for generic events

Returns:

this builder instance, allowing for method chaining

metaData

default MethodWriterBuilder<T> metaData(boolean metaData)

Controls whether metadata should be included in the binary stream.

Parameters:

metaData - true if metadata should be included; false otherwise

Returns:

this builder, so invocations can be chained

onClose

MethodWriterBuilder<T> onClose(net.openhft.chronicle.core.io.Closeable closeable)

Specifies a Closeable that should be invoked when the MethodWriter is closed.

Parameters:

closeable - the Closeable to invoke when the MethodWriter is closed

Returns:

this builder, so invocations can be chained

updateInterceptor

default MethodWriterBuilder<T> updateInterceptor(UpdateInterceptor updateInterceptor)

Specifies an UpdateInterceptor for the MethodWriter.

Parameters:

updateInterceptor - the UpdateInterceptor to use

Returns:

this builder, so invocations can be chained

Throws:

UnsupportedOperationException - if the implementation does not support this operation

verboseTypes

default MethodWriterBuilder<T> verboseTypes(boolean verboseTypes)

Controls whether type information should be included in a verbose manner.

NOTE: If you are using JSONWire, you also need to set useTypes(true) to include type information.

Parameters:

verboseTypes - true if type information should be verbose; false otherwise

Returns:

this builder, so invocations can be chained

build

default T build()

Builds the MethodWriter instance.

Returns:

the built MethodWriter instance