net.openhft.chronicle.wire

Class VanillaMethodWriterBuilder<T>

java.lang.Object

net.openhft.chronicle.wire.VanillaMethodWriterBuilder<T>

All Implemented Interfaces:

Supplier<T>, net.openhft.chronicle.bytes.MethodWriterBuilder<T>, net.openhft.chronicle.core.util.Builder<T>

public class VanillaMethodWriterBuilder<T>
extends Object
implements net.openhft.chronicle.core.util.Builder<T>, net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Builder for dynamic proxies that write method calls to a MarshallableOut.

The writer attempts to generate and compile a dedicated implementation for the configured interfaces. If generation is disabled or fails it falls back to a standard Proxy.

Options include additional interfaces, generic event handling and update interceptors. By default a thread-local invocation handler is used but this can be overridden via disableThreadSafe(boolean).

See Also:

MethodWriter, MarshallableOut.methodWriterBuilder(Class)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_WRITER_PROXY_CODEGEN

Constructor Summary

Constructors

Constructor and Description
VanillaMethodWriterBuilder(@NotNull Class<T> tClass, WireType wireType, @NotNull Supplier<net.openhft.chronicle.bytes.MethodWriterInvocationHandler> handlerSupplier) Constructs an instance of VanillaMethodWriterBuilder with the specified class type, wire type, and an invocation handler supplier.

Method Summary

Modifier and Type	Method and Description
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	addInterface(Class<?> additionalClass) Adds an interface to the set of interfaces managed by this builder.
T	build() Builds the method writer proxy.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	classLoader(ClassLoader classLoader) Configures the class loader to be used for dynamic class generation and loading.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	disableThreadSafe(boolean theadSafe) Controls whether the same invocation handler instance can be reused across threads.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	genericEvent(String genericEvent) A generic event treats the first argument as the eventName
T	get() Returns the method writer proxy instance.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	marshallableOut(@NotNull MarshallableOut out) Sends method calls to the given MarshallableOut.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	marshallableOutSupplier(@NotNull Supplier<MarshallableOut> out) Uses a supplier to obtain the MarshallableOut for each call.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	metaData(boolean metaData) Specifies whether the builder should include metadata or not.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	onClose(net.openhft.chronicle.core.io.Closeable closeable) Registers a closeable resource with the method writer invocation handler.
Class<?>	proxyClass()
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	proxyClass(Class<?> proxyClass) Sets the proxy class to be used by the builder.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	updateInterceptor(net.openhft.chronicle.bytes.UpdateInterceptor updateInterceptor) Sets an UpdateInterceptor to be invoked before each method call.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	verboseTypes(boolean verboseTypes)
WireType	wireType()
VanillaMethodWriterBuilder<T>	wireType(WireType wireType) Sets the WireType used by the generated writer.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_WRITER_PROXY_CODEGEN

public static final String DISABLE_WRITER_PROXY_CODEGEN

See Also:

Constant Field Values

Constructor Detail

VanillaMethodWriterBuilder

public VanillaMethodWriterBuilder(@NotNull
                                  @NotNull Class<T> tClass,
                                  WireType wireType,
                                  @NotNull
                                  @NotNull Supplier<net.openhft.chronicle.bytes.MethodWriterInvocationHandler> handlerSupplier)

Constructs an instance of VanillaMethodWriterBuilder with the specified class type, wire type, and an invocation handler supplier.

Parameters:

tClass - The class type that the builder will be working on.

wireType - The wire type to be used for the method writer.

handlerSupplier - Supplier to provide invocation handlers for the method writer.

Method Detail

classLoader

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> classLoader(ClassLoader classLoader)

Configures the class loader to be used for dynamic class generation and loading.

Parameters:

classLoader - The class loader to be set.

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

updateInterceptor

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> updateInterceptor(net.openhft.chronicle.bytes.UpdateInterceptor updateInterceptor)

Sets an UpdateInterceptor to be invoked before each method call. The interceptor may veto the call by returning false.

Specified by:

updateInterceptor in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Returns:

this builder

verboseTypes

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> verboseTypes(boolean verboseTypes)

Specified by:

verboseTypes in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Returns:

this builder after setting whether type names should be written verbosely

addInterface

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> addInterface(Class<?> additionalClass)

Adds an interface to the set of interfaces managed by this builder. This method ensures that the provided interface does not violate any constraints (like invalidSuperInterfaces) and adds it to the internal collection. Additionally, it recursively processes return types of the methods in the provided interface and adds them if they are also interfaces.

Parameters:

additionalClass - The interface to be added.

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

Throws:

IllegalArgumentException - if the provided interface is deemed invalid.

disableThreadSafe

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> disableThreadSafe(boolean theadSafe)

Controls whether the same invocation handler instance can be reused across threads. When true a single non-thread-safe handler may be shared.

Returns:

this builder

build

@NotNull
public T build()

Builds the method writer proxy. Tries to use a compiled implementation and falls back to a standard Proxy if generation is disabled or fails.

Specified by:

build in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Specified by:

build in interface net.openhft.chronicle.core.util.Builder<T>

Returns:

a new proxy implementing T

Throws:

NullPointerException - if marshallableOut(MarshallableOut) was not configured

onClose

@NotNull
public @NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T> onClose(net.openhft.chronicle.core.io.Closeable closeable)

Registers a closeable resource with the method writer invocation handler. This closeable will be invoked when the handler's close method is called.

Specified by:

onClose in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Parameters:

closeable - The closeable resource to be registered.

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

wireType

public WireType wireType()

Returns:

current WireType for the writer

wireType

public VanillaMethodWriterBuilder<T> wireType(WireType wireType)

Sets the WireType used by the generated writer.

Returns:

this builder

get

@NotNull
public T get()

Returns the method writer proxy instance. Tries to reuse or generate a compiled class before falling back to Proxy.

Specified by:

get in interface Supplier<T>

Specified by:

get in interface net.openhft.chronicle.core.util.Builder<T>

genericEvent

public net.openhft.chronicle.bytes.MethodWriterBuilder<T> genericEvent(String genericEvent)

A generic event treats the first argument as the eventName

Specified by:

genericEvent in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Parameters:

genericEvent - name

Returns:

this

marshallableOut

public net.openhft.chronicle.bytes.MethodWriterBuilder<T> marshallableOut(@NotNull
                                                                          @NotNull MarshallableOut out)

Sends method calls to the given MarshallableOut.

marshallableOutSupplier

public net.openhft.chronicle.bytes.MethodWriterBuilder<T> marshallableOutSupplier(@NotNull
                                                                                  @NotNull Supplier<MarshallableOut> out)

Uses a supplier to obtain the MarshallableOut for each call.

metaData

public net.openhft.chronicle.bytes.MethodWriterBuilder<T> metaData(boolean metaData)

Specifies whether the builder should include metadata or not.

Specified by:

metaData in interface net.openhft.chronicle.bytes.MethodWriterBuilder<T>

Parameters:

metaData - A boolean indicating whether to include metadata.

Returns:

The current instance of the MethodWriterBuilder, allowing chained method calls.

proxyClass

public Class<?> proxyClass()

Returns:

pre-compiled proxy class if set

proxyClass

public net.openhft.chronicle.bytes.MethodWriterBuilder<T> proxyClass(Class<?> proxyClass)

Sets the proxy class to be used by the builder. The provided class must not be an interface.

Parameters:

proxyClass - The class to be set as the proxy class.

Returns:

The current instance of the MethodWriterBuilder, allowing chained method calls.

Throws:

IllegalArgumentException - If the provided class is an interface.