Record Class RPCGenerationContext.AdditionalInstanceFactoryField

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.defaults.generation.RPCGenerationContext.AdditionalInstanceFactoryField

Record Components:

name - the name of the field.

targetType - the target type that is being constructed by the factory.

instanceFactory - the instance factory.

Enclosing class:

RPCGenerationContext

private static record RPCGenerationContext.AdditionalInstanceFactoryField(@NonNull String name, @NonNull Class<?> targetType, @NonNull RPCInternalInstanceFactory instanceFactory)
extends Record

AdditionalInstanceFactoryField relies on preview features of the Java platform:

• AdditionalInstanceFactoryField refers to one or more preview APIs: ClassBuilder, CodeBuilder.

Programs can only use AdditionalInstanceFactoryField when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

A field that holds an additional instance factory that is accessed to allocate instances of chain classes.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull RPCInternalInstanceFactory	instanceFactory	The field for the instanceFactory record component.
private final @NonNull String	name	The field for the name record component.
private final @NonNull Class<?>	targetType	The field for the targetType record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AdditionalInstanceFactoryField(@NonNull String name, @NonNull Class<?> targetType, @NonNull RPCInternalInstanceFactory instanceFactory)	Creates an instance of a AdditionalInstanceFactoryField record class.

Method Summary

Modifier and Type	Method	Description
void	applyToClassAndConstructor(int fieldIndex, @NonNull ClassDesc generatingClass, @NonNull ClassBuilderPREVIEW classBuilder, @NonNull CodeBuilderPREVIEW constructorCode)	Adds this field into the target class builder and adds code to the constructor to initialize the field value.
boolean	equals(@Nullable Object o)
static @NonNull RPCGenerationContext.AdditionalInstanceFactoryField	forFactory(@NonNull Class<?> targetType, @NonNull RPCInternalInstanceFactory instanceFactory)	Constructs a field that holds an additional instance factory for the given target type.
int	hashCode()
@NonNull RPCInternalInstanceFactory	instanceFactory()	Returns the value of the instanceFactory record component.
@NonNull String	name()	Returns the value of the name record component.
@NonNull Class<?>	targetType()	Returns the value of the targetType record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

name

@NonNull
private final @NonNull String name

The field for the name record component.

targetType

@NonNull
private final @NonNull Class<?> targetType

The field for the targetType record component.

instanceFactory

@NonNull
private final @NonNull RPCInternalInstanceFactory instanceFactory

The field for the instanceFactory record component.

Constructor Details

AdditionalInstanceFactoryField

private AdditionalInstanceFactoryField(@NonNull
 @NonNull String name,
 @NonNull
 @NonNull Class<?> targetType,
 @NonNull
 @NonNull RPCInternalInstanceFactory instanceFactory)

Creates an instance of a AdditionalInstanceFactoryField record class.

Parameters:

name - the value for the name record component

targetType - the value for the targetType record component

instanceFactory - the value for the instanceFactory record component

Method Details

forFactory

@NonNull
public static @NonNull RPCGenerationContext.AdditionalInstanceFactoryField forFactory(@NonNull
 @NonNull Class<?> targetType,
 @NonNull
 @NonNull RPCInternalInstanceFactory instanceFactory)

Constructs a field that holds an additional instance factory for the given target type.

Parameters:

targetType - the target type which is constructed by the instance factory.

instanceFactory - the instance factory that should be used for initialisation.

Returns:

the generated factory field information.

Throws:

NullPointerException - if the given target type or instance factory is null.

applyToClassAndConstructor

public void applyToClassAndConstructor(int fieldIndex,
 @NonNull
 @NonNull ClassDesc generatingClass,
 @NonNull
 @NonNull ClassBuilderPREVIEW classBuilder,
 @NonNull
 @NonNull CodeBuilderPREVIEW constructorCode)

Adds this field into the target class builder and adds code to the constructor to initialize the field value. This method uses a deterministic way to generate the field name, so each invocation leads to the same field name result.

Parameters:

fieldIndex - the index of the current field that is being added to the class (1-based).

generatingClass - the descriptor of the class that is being generated.

classBuilder - the builder of the class being generated.

constructorCode - the builder of the constructor code for the current class.

Throws:

NullPointerException - if the current class desc, class builder or constructor builder is null.

equals

public boolean equals(@Nullable
 @Nullable Object o)

Specified by:

equals in class Record

hashCode

public int hashCode()

Specified by:

hashCode in class Record

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

name

@NonNull
public @NonNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

targetType

@NonNull
public @NonNull Class<?> targetType()

Returns the value of the targetType record component.

Returns:

the value of the targetType record component

instanceFactory

@NonNull
public @NonNull RPCInternalInstanceFactory instanceFactory()

Returns the value of the instanceFactory record component.

Returns:

the value of the instanceFactory record component