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>

This is the VanillaMethodWriterBuilder class implementing both Builder and MethodWriterBuilder interfaces. It is responsible for constructing method writers based on specified configurations and properties. The class has been designed to support a variety of functionalities like code generation disabling, proxy generation, and method invocation handling among others.

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() Constructs and returns the method writer object based on the configurations set.
@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) Configures the thread-safety for the method writer invocation handler.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	genericEvent(String genericEvent) A generic event treats the first argument as the eventName
T	get()
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	marshallableOut(@NotNull MarshallableOut out) Sets the MarshallableOut instance to be used by the builder.
net.openhft.chronicle.bytes.MethodWriterBuilder<T>	marshallableOutSupplier(@NotNull Supplier<MarshallableOut> out) Sets the supplier for the MarshallableOut to be used by the builder.
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() Retrieves the proxy class being used by the builder.
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) Specifies if verbose types should be used during method writing.
@NotNull net.openhft.chronicle.bytes.MethodWriterBuilder<T>	verboseTypes(boolean verboseTypes)
WireType	wireType() Fetches the wire type configuration set for the method writer.
VanillaMethodWriterBuilder<T>	wireType(WireType wireType) Configures the wire type for the method 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)

Specifies if verbose types should be used during method writing.

Specified by:

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

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

verboseTypes

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

Specified by:

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

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 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)

Configures the thread-safety for the method writer invocation handler. If thread-safety is disabled, this method will adjust the handler's behavior to not be thread-safe. Otherwise, it will be thread-safe by default.

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

build

@NotNull
public T build()

Constructs and returns the method writer object based on the configurations set.

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 newly constructed method writer of type T.

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()

Fetches the wire type configuration set for the method writer.

Returns:

The current wire type.

wireType

public VanillaMethodWriterBuilder<T> wireType(WireType wireType)

Configures the wire type for the method writer.

Parameters:

wireType - The wire type to be set.

Returns:

The current instance of VanillaMethodWriterBuilder for chaining method calls.

get

@NotNull
public T get()

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)

Sets the MarshallableOut instance to be used by the builder. This will internally set a supplier that always returns the given instance.

Parameters:

out - The instance of MarshallableOut to be set.

Returns:

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

marshallableOutSupplier

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

Sets the supplier for the MarshallableOut to be used by the builder.

Parameters:

out - The supplier of MarshallableOut to be set.

Returns:

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

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()

Retrieves the proxy class being used by the builder.

Returns:

The current proxy class.

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.