Package eu.cloudnetservice.driver.network.rpc.generation

Record Class GenerationContext

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.generation.GenerationContext

Record Components:

component - the network component to use when firing the rpc.

channelSupplier - the supplier for the network component invoked when firing the rpc.

objectMapper - the object mapper mapping the databuf back to an object.

dataBufFactory - the databuf factory to use when creating databufs for the generation factory.

extendingClass - the class the generated class should extend, null for none.

interfaces - the interfaces the generated class should implement.

implementAllMethods - if all methods or only abstract methods should get implemented.

public record GenerationContext(@Nullable NetworkComponent component, @Nullable Supplier<NetworkChannel> channelSupplier, @Nullable ObjectMapper objectMapper, @Nullable DataBufFactory dataBufFactory, @Nullable Class<?> extendingClass, @NonNull Set<Class<?>> interfaces, boolean implementAllMethods)
extends Record

A context for the generation of a class which implements some kind of api which only calls methods using rpc.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GenerationContext.Builder	Represents a builder for a generation context.

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable Supplier<NetworkChannel>	channelSupplier	The field for the channelSupplier record component.
private final @Nullable NetworkComponent	component	The field for the component record component.
private final @Nullable DataBufFactory	dataBufFactory	The field for the dataBufFactory record component.
private final @Nullable Class<?>	extendingClass	The field for the extendingClass record component.
private final boolean	implementAllMethods	The field for the implementAllMethods record component.
private final @NonNull Set<Class<?>>	interfaces	The field for the interfaces record component.
private final @Nullable ObjectMapper	objectMapper	The field for the objectMapper record component.

Constructor Summary

Constructors

Constructor	Description
GenerationContext(@Nullable NetworkComponent component, @Nullable Supplier<NetworkChannel> channelSupplier, @Nullable ObjectMapper objectMapper, @Nullable DataBufFactory dataBufFactory, @Nullable Class<?> extendingClass, @NonNull Set<Class<?>> interfaces, boolean implementAllMethods)	Creates an instance of a GenerationContext record class.

Method Summary

Modifier and Type	Method	Description
static @NonNull GenerationContext.Builder	builder()	Creates a new builder instance for a generation context.
@Nullable Supplier<NetworkChannel>	channelSupplier()	Returns the value of the channelSupplier record component.
@Nullable NetworkComponent	component()	Returns the value of the component record component.
@Nullable DataBufFactory	dataBufFactory()	Returns the value of the dataBufFactory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable Class<?>	extendingClass()	Returns the value of the extendingClass record component.
static @NonNull GenerationContext.Builder	forClass(@NonNull Class<?> clazz)	Creates a new generation context based on the given input class.
final int	hashCode()	Returns a hash code value for this object.
boolean	implementAllMethods()	Returns the value of the implementAllMethods record component.
@NonNull Set<Class<?>>	interfaces()	Returns the value of the interfaces record component.
@Nullable ObjectMapper	objectMapper()	Returns the value of the objectMapper 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

component

@Nullable
private final @Nullable NetworkComponent component

The field for the component record component.

channelSupplier

@Nullable
private final @Nullable Supplier<NetworkChannel> channelSupplier

The field for the channelSupplier record component.

objectMapper

@Nullable
private final @Nullable ObjectMapper objectMapper

The field for the objectMapper record component.

dataBufFactory

@Nullable
private final @Nullable DataBufFactory dataBufFactory

The field for the dataBufFactory record component.

extendingClass

@Nullable
private final @Nullable Class<?> extendingClass

The field for the extendingClass record component.

interfaces

@NonNull
private final @NonNull Set<Class<?>> interfaces

The field for the interfaces record component.

implementAllMethods

private final boolean implementAllMethods

The field for the implementAllMethods record component.

Constructor Details

GenerationContext

public GenerationContext(@Nullable
 @Nullable NetworkComponent component,
 @Nullable
 @Nullable Supplier<NetworkChannel> channelSupplier,
 @Nullable
 @Nullable ObjectMapper objectMapper,
 @Nullable
 @Nullable DataBufFactory dataBufFactory,
 @Nullable
 @Nullable Class<?> extendingClass,
 @NonNull
 @NonNull Set<Class<?>> interfaces,
 boolean implementAllMethods)

Creates an instance of a GenerationContext record class.

Parameters:

component - the value for the component record component

channelSupplier - the value for the channelSupplier record component

objectMapper - the value for the objectMapper record component

dataBufFactory - the value for the dataBufFactory record component

extendingClass - the value for the extendingClass record component

interfaces - the value for the interfaces record component

implementAllMethods - the value for the implementAllMethods record component

Method Details

builder

@NonNull
public static @NonNull GenerationContext.Builder builder()

Creates a new builder instance for a generation context.

Returns:

a new generation context builder.

forClass

@NonNull
public static @NonNull GenerationContext.Builder forClass(@NonNull
 @NonNull Class<?> clazz)

Creates a new generation context based on the given input class.

Parameters:

clazz - the class to either extend or implement.

Returns:

a new generation context builder, trying to extend/implement the given class

Throws:

NullPointerException - if the given class is null.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

component

@Nullable
public @Nullable NetworkComponent component()

Returns the value of the component record component.

Returns:

the value of the component record component

channelSupplier

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

Returns the value of the channelSupplier record component.

Returns:

the value of the channelSupplier record component

objectMapper

@Nullable
public @Nullable ObjectMapper objectMapper()

Returns the value of the objectMapper record component.

Returns:

the value of the objectMapper record component

dataBufFactory

@Nullable
public @Nullable DataBufFactory dataBufFactory()

Returns the value of the dataBufFactory record component.

Returns:

the value of the dataBufFactory record component

extendingClass

@Nullable
public @Nullable Class<?> extendingClass()

Returns the value of the extendingClass record component.

Returns:

the value of the extendingClass record component

interfaces

@NonNull
public @NonNull Set<Class<?>> interfaces()

Returns the value of the interfaces record component.

Returns:

the value of the interfaces record component

implementAllMethods

public boolean implementAllMethods()

Returns the value of the implementAllMethods record component.

Returns:

the value of the implementAllMethods record component