Record Class DefaultRPCImplementationBuilder.DefaultInstanceAllocator<T>

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.defaults.generation.DefaultRPCImplementationBuilder.DefaultInstanceAllocator<T>

Type Parameters:

T - the type that is being constructed by the allocator.

Record Components:

baseRPC - the base rpc to use for the constructed rpc implementation.

classRPCSender - the rpc sender to use for the generated class.

channelSupplier - thw channel supplier to use for rpc executions.

additionalConstructorParameters - the additional super constructor parameters.

internalInstanceFactory - the internal instance factory to delegate to.

All Implemented Interfaces:

RPCImplementationBuilder.InstanceAllocator<T>

Enclosing class:

DefaultRPCImplementationBuilder<T>

private static record DefaultRPCImplementationBuilder.DefaultInstanceAllocator<T>(@Nullable ChainableRPC baseRPC, @NonNull RPCSender classRPCSender, @NonNull Supplier<NetworkChannel> channelSupplier, @NonNull Object[] additionalConstructorParameters, @NonNull RPCInternalInstanceFactory internalInstanceFactory)
extends Record
implements RPCImplementationBuilder.InstanceAllocator<T>

The default implementation of an instance allocator using an internal instance factory as delegation.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull Object[]	additionalConstructorParameters	The field for the additionalConstructorParameters record component.
private final @Nullable ChainableRPC	baseRPC	The field for the baseRPC record component.
private final @NonNull Supplier<NetworkChannel>	channelSupplier	The field for the channelSupplier record component.
private final @NonNull RPCSender	classRPCSender	The field for the classRPCSender record component.
private final @NonNull RPCInternalInstanceFactory	internalInstanceFactory	The field for the internalInstanceFactory record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultInstanceAllocator(@Nullable ChainableRPC baseRPC, @NonNull RPCSender classRPCSender, @NonNull Supplier<NetworkChannel> channelSupplier, @NonNull Object[] additionalConstructorParameters, @NonNull RPCInternalInstanceFactory internalInstanceFactory)	Creates an instance of a DefaultInstanceAllocator record class.

Method Summary

Modifier and Type	Method	Description
@NonNull Object[]	additionalConstructorParameters()	Returns the value of the additionalConstructorParameters record component.
T	allocate()	Allocates an instance of the generated implementation based on the provided arguments.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	appendConstructorParameters(Object... parameters)	Appends the given parameters to the current parameter array.
@Nullable ChainableRPC	baseRPC()	Returns the value of the baseRPC record component.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	changeConstructorParameter(int index, Object newConstructorParameter)	Changes the parameter value at the given index to use the given parameter type instead.
@NonNull Supplier<NetworkChannel>	channelSupplier()	Returns the value of the channelSupplier record component.
@NonNull RPCSender	classRPCSender()	Returns the value of the classRPCSender record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	insertConstructorParameters(int index, Object... parameters)	Adds the parameters from the given starting index into the constructor parameter array.
@NonNull RPCInternalInstanceFactory	internalInstanceFactory()	Returns the value of the internalInstanceFactory record component.
final String	toString()	Returns a string representation of this record class.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	withAdditionalConstructorParameters(Object... additionalConstructorParams)	Sets the additional constructor parameters which should be passed to the super constructor when allocating an instance of the generated api implementation.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	withBaseRPC(@Nullable ChainableRPC baseRPC)	Returns a new instance allocator which uses the given base rpc when constructing the underlying implementation.
@NonNull RPCImplementationBuilder.InstanceAllocator<T>	withTargetChannel(@NonNull Supplier<NetworkChannel> channelSupplier)	Returns a new instance allocator which uses the given channel supplier when constructing the underlying implementation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

baseRPC

@Nullable
private final @Nullable ChainableRPC baseRPC

The field for the baseRPC record component.

classRPCSender

@NonNull
private final @NonNull RPCSender classRPCSender

The field for the classRPCSender record component.

channelSupplier

@NonNull
private final @NonNull Supplier<NetworkChannel> channelSupplier

The field for the channelSupplier record component.

additionalConstructorParameters

@NonNull
private final @NonNull Object[] additionalConstructorParameters

The field for the additionalConstructorParameters record component.

internalInstanceFactory

@NonNull
private final @NonNull RPCInternalInstanceFactory internalInstanceFactory

The field for the internalInstanceFactory record component.

Constructor Details

DefaultInstanceAllocator

private DefaultInstanceAllocator(@Nullable
 @Nullable ChainableRPC baseRPC,
 @NonNull
 @NonNull RPCSender classRPCSender,
 @NonNull
 @NonNull Supplier<NetworkChannel> channelSupplier,
 @NonNull
 @NonNull Object[] additionalConstructorParameters,
 @NonNull
 @NonNull RPCInternalInstanceFactory internalInstanceFactory)

Creates an instance of a DefaultInstanceAllocator record class.

Parameters:

baseRPC - the value for the baseRPC record component

classRPCSender - the value for the classRPCSender record component

channelSupplier - the value for the channelSupplier record component

additionalConstructorParameters - the value for the additionalConstructorParameters record component

internalInstanceFactory - the value for the internalInstanceFactory record component

Method Details

withBaseRPC

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> withBaseRPC(@Nullable
 @Nullable ChainableRPC baseRPC)

Returns a new instance allocator which uses the given base rpc when constructing the underlying implementation.

Specified by:

withBaseRPC in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

baseRPC - the base rpc to use for the rpc executions in the target class, can be null.

Returns:

a new instance allocator instance which uses the given base rpc when allocating.

withTargetChannel

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> withTargetChannel(@NonNull
 @NonNull Supplier<NetworkChannel> channelSupplier)

Returns a new instance allocator which uses the given channel supplier when constructing the underlying implementation.

Specified by:

withTargetChannel in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

channelSupplier - the channel supplier to use as a target for all rpc calls.

Returns:

a new instance allocator which uses the given channel supplier when allocating.

withAdditionalConstructorParameters

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> withAdditionalConstructorParameters(Object... additionalConstructorParams)

Sets the additional constructor parameters which should be passed to the super constructor when allocating an instance of the generated api implementation.

Specified by:

withAdditionalConstructorParameters in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

additionalConstructorParams - the additional constructor arguments to pass to the super constructor.

Returns:

a new instance allocator which uses the given additional constructor parameters when allocating.

changeConstructorParameter

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> changeConstructorParameter(int index,
 Object newConstructorParameter)

Changes the parameter value at the given index to use the given parameter type instead.

Specified by:

changeConstructorParameter in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

index - the index of the parameter to change.

newConstructorParameter - the new parameter value to use.

Returns:

a new instance allocator with the parameter value changed at the given index.

insertConstructorParameters

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> insertConstructorParameters(int index,
 Object... parameters)

Adds the parameters from the given starting index into the constructor parameter array.

Specified by:

insertConstructorParameters in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

index - the index where to start the parameter insertion.

parameters - the parameters to insert.

Returns:

a new instance allocator with the given parameters added.

appendConstructorParameters

@NonNull
public @NonNull RPCImplementationBuilder.InstanceAllocator<T> appendConstructorParameters(Object... parameters)

Appends the given parameters to the current parameter array.

Specified by:

appendConstructorParameters in interface RPCImplementationBuilder.InstanceAllocator<T>

Parameters:

parameters - the parameter values to append.

Returns:

a new instance allocator with the given parameters appended.

allocate

@NonNull
public T allocate()

Allocates an instance of the generated implementation based on the provided arguments.

Specified by:

allocate in interface RPCImplementationBuilder.InstanceAllocator<T>

Returns:

an allocated instance of the implemented target class.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

baseRPC

@Nullable
public @Nullable ChainableRPC baseRPC()

Returns the value of the baseRPC record component.

Returns:

the value of the baseRPC record component

classRPCSender

@NonNull
public @NonNull RPCSender classRPCSender()

Returns the value of the classRPCSender record component.

Returns:

the value of the classRPCSender record component

channelSupplier

@NonNull
public @NonNull Supplier<NetworkChannel> channelSupplier()

Returns the value of the channelSupplier record component.

Returns:

the value of the channelSupplier record component

additionalConstructorParameters

@NonNull
public @NonNull Object[] additionalConstructorParameters()

Returns the value of the additionalConstructorParameters record component.

Returns:

the value of the additionalConstructorParameters record component

internalInstanceFactory

@NonNull
public @NonNull RPCInternalInstanceFactory internalInstanceFactory()

Returns the value of the internalInstanceFactory record component.

Returns:

the value of the internalInstanceFactory record component