Record Class RPCMethodMetadata

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.network.rpc.introspec.RPCMethodMetadata

Record Components:

concrete - if the method is concretely implemented, false if the method is abstract.

asyncReturnType - if the method has an async return type (returns a supported future subtype).

compilerGenerated - if the method was inserted into the class by the compiler.

executionResultIgnored - if the method was specifically annotated to not wait for the rpc execution.

name - the name of the method.

returnType - the full generic return type of the method.

unwrappedReturnType - the return type of the method after unwrapping, e.g. if the returning an async type.

parameterTypes - the fully generic parameter types.

methodType - the method type of the method.

definingClass - the class in which the method is defined.

executionTimeout - the execution timeout of the method, null if not defined.

chainMetadata - the metadata for chain implementation, if annotated with RPCChained.

public record RPCMethodMetadata(boolean concrete, boolean asyncReturnType, boolean compilerGenerated, boolean executionResultIgnored, @NonNull String name, @NonNull Type returnType, @NonNull Type unwrappedReturnType, @NonNull Type[] parameterTypes, @NonNull MethodType methodType, @NonNull Class<?> definingClass, @Nullable Duration executionTimeout, @Nullable RPCMethodMetadata.MethodChainMetadata chainMetadata)
extends Record

Metadata information about a method that can be used with RPC.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RPCMethodMetadata.MethodChainMetadata	Metadata information for a chained invocation.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	asyncReturnType	The field for the asyncReturnType record component.
private final @Nullable RPCMethodMetadata.MethodChainMetadata	chainMetadata	The field for the chainMetadata record component.
private final boolean	compilerGenerated	The field for the compilerGenerated record component.
private final boolean	concrete	The field for the concrete record component.
private final @NonNull Class<?>	definingClass	The field for the definingClass record component.
private final boolean	executionResultIgnored	The field for the executionResultIgnored record component.
private final @Nullable Duration	executionTimeout	The field for the executionTimeout record component.
private final @NonNull MethodType	methodType	The field for the methodType record component.
private final @NonNull String	name	The field for the name record component.
private final @NonNull Type[]	parameterTypes	The field for the parameterTypes record component.
private final @NonNull Type	returnType	The field for the returnType record component.
private final @NonNull Type	unwrappedReturnType	The field for the unwrappedReturnType record component.

Constructor Summary

Constructors

Constructor	Description
RPCMethodMetadata(boolean concrete, boolean asyncReturnType, boolean compilerGenerated, boolean executionResultIgnored, @NonNull String name, @NonNull Type returnType, @NonNull Type unwrappedReturnType, @NonNull Type[] parameterTypes, @NonNull MethodType methodType, @NonNull Class<?> definingClass, @Nullable Duration executionTimeout, @Nullable RPCMethodMetadata.MethodChainMetadata chainMetadata)	Creates an instance of a RPCMethodMetadata record class.

Method Summary

Modifier and Type	Method	Description
boolean	asyncReturnType()	Returns the value of the asyncReturnType record component.
@Nullable RPCMethodMetadata.MethodChainMetadata	chainMetadata()	Returns the value of the chainMetadata record component.
boolean	compilerGenerated()	Returns the value of the compilerGenerated record component.
boolean	concrete()	Returns the value of the concrete record component.
@NonNull Class<?>	definingClass()	Returns the value of the definingClass record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	executionResultIgnored()	Returns the value of the executionResultIgnored record component.
@Nullable Duration	executionTimeout()	Returns the value of the executionTimeout record component.
private static @Nullable RPCMethodMetadata.MethodChainMetadata	extractAndValidateChainMeta(@NonNull Method method, @NonNull Class<?> rawReturnType, @Nullable RPCChained chainAnnotation)	Extract and validate the metadata of the chain annotation information.
(package private) static @NonNull RPCMethodMetadata	fromMethod(@NonNull Method method)	Constructs and validates a rpc method metadata based on the properties of the given method.
final int	hashCode()	Returns a hash code value for this object.
@NonNull MethodType	methodType()	Returns the value of the methodType record component.
@NonNull String	name()	Returns the value of the name record component.
@NonNull Type[]	parameterTypes()	Returns the value of the parameterTypes record component.
@NonNull Type	returnType()	Returns the value of the returnType record component.
final String	toString()	Returns a string representation of this record class.
@NonNull Type	unwrappedReturnType()	Returns the value of the unwrappedReturnType record component.
private static @Nullable Type	unwrapWrappedFutureType(@NonNull Method method, @NonNull Type type)	Unwraps the first (and only) type parameter of the given type, if the raw type is a future, to get the actual return type to use for network codec.
private static void	validateBounds(@NonNull Method method, @NonNull Type type)	Ensures that the given type is fully bound, throwing an exception if that is not the case.
private static void	validateChainBaseClass(@NonNull Method method, @NonNull Class<?> chainBaseImpl)	Validates that the given chain base class is valid and can be implemented by code generation.

Methods inherited from class java.lang.Object

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

Field Details

concrete

private final boolean concrete

The field for the concrete record component.

asyncReturnType

private final boolean asyncReturnType

The field for the asyncReturnType record component.

compilerGenerated

private final boolean compilerGenerated

The field for the compilerGenerated record component.

executionResultIgnored

private final boolean executionResultIgnored

The field for the executionResultIgnored record component.

name

@NonNull
private final @NonNull String name

The field for the name record component.

returnType

@NonNull
private final @NonNull Type returnType

The field for the returnType record component.

unwrappedReturnType

@NonNull
private final @NonNull Type unwrappedReturnType

The field for the unwrappedReturnType record component.

parameterTypes

@NonNull
private final @NonNull Type[] parameterTypes

The field for the parameterTypes record component.

methodType

@NonNull
private final @NonNull MethodType methodType

The field for the methodType record component.

definingClass

@NonNull
private final @NonNull Class<?> definingClass

The field for the definingClass record component.

executionTimeout

@Nullable
private final @Nullable Duration executionTimeout

The field for the executionTimeout record component.

chainMetadata

@Nullable
private final @Nullable RPCMethodMetadata.MethodChainMetadata chainMetadata

The field for the chainMetadata record component.

Constructor Details

RPCMethodMetadata

public RPCMethodMetadata(boolean concrete,
 boolean asyncReturnType,
 boolean compilerGenerated,
 boolean executionResultIgnored,
 @NonNull
 @NonNull String name,
 @NonNull
 @NonNull Type returnType,
 @NonNull
 @NonNull Type unwrappedReturnType,
 @NonNull
 @NonNull Type[] parameterTypes,
 @NonNull
 @NonNull MethodType methodType,
 @NonNull
 @NonNull Class<?> definingClass,
 @Nullable
 @Nullable Duration executionTimeout,
 @Nullable
 @Nullable RPCMethodMetadata.MethodChainMetadata chainMetadata)

Creates an instance of a RPCMethodMetadata record class.

Parameters:

concrete - the value for the concrete record component

asyncReturnType - the value for the asyncReturnType record component

compilerGenerated - the value for the compilerGenerated record component

executionResultIgnored - the value for the executionResultIgnored record component

name - the value for the name record component

returnType - the value for the returnType record component

unwrappedReturnType - the value for the unwrappedReturnType record component

parameterTypes - the value for the parameterTypes record component

methodType - the value for the methodType record component

definingClass - the value for the definingClass record component

executionTimeout - the value for the executionTimeout record component

chainMetadata - the value for the chainMetadata record component

Method Details

fromMethod

@NonNull
static @NonNull RPCMethodMetadata fromMethod(@NonNull
 @NonNull Method method)

Constructs and validates a rpc method metadata based on the properties of the given method.

Parameters:

method - the method to construct the rpc method metadata for.

Returns:

the constructed rpc method metadata.

Throws:

NullPointerException - if the given method is null.

IllegalStateException - if some precondition, to ensure functionality with rpc, fails.

validateBounds

private static void validateBounds(@NonNull
 @NonNull Method method,
 @NonNull
 @NonNull Type type)

Ensures that the given type is fully bound, throwing an exception if that is not the case. The given method will be used as a hint to direct into the direction of the method that caused the issue.

Parameters:

method - the method that is related to the type being checked.

type - the type to check if fully bound.

Throws:

NullPointerException - if the given method or type is null.

IllegalStateException - if the given type is not fully bound.

extractAndValidateChainMeta

@Nullable
private static @Nullable RPCMethodMetadata.MethodChainMetadata extractAndValidateChainMeta(@NonNull
 @NonNull Method method,
 @NonNull
 @NonNull Class<?> rawReturnType,
 @Nullable
 @Nullable RPCChained chainAnnotation)

Extract and validate the metadata of the chain annotation information. Returns null if the given chain annotation is null.

Parameters:

method - the method on which the chain annotation is located.

rawReturnType - the raw return type of the method.

chainAnnotation - the chain annotation instance located on the method.

Returns:

the extracted method chain metadata.

Throws:

NullPointerException - if the given method or raw return type is null.

IllegalStateException - if chain annotation has invalid data provided.

validateChainBaseClass

private static void validateChainBaseClass(@NonNull
 @NonNull Method method,
 @NonNull
 @NonNull Class<?> chainBaseImpl)

Validates that the given chain base class is valid and can be implemented by code generation.

Parameters:

method - the method on which the chain annotation is located.

chainBaseImpl - the chain base type which should be implemented.

Throws:

NullPointerException - if the given method or class is null.

IllegalStateException - if a validation error occurs.

unwrapWrappedFutureType

@Nullable
private static @Nullable Type unwrapWrappedFutureType(@NonNull
 @NonNull Method method,
 @NonNull
 @NonNull Type type)

Unwraps the first (and only) type parameter of the given type, if the raw type is a future, to get the actual return type to use for network codec.

Parameters:

method - the method that is related to the type being unwrapped.

type - the type to unwrap the future return type of.

Returns:

the return type of the given future, null if the given type is not a future.

Throws:

NullPointerException - if the given type or method is null.

IllegalStateException - if the given type has no or multiple type parameters while being a future.

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 the compare method from their corresponding wrapper classes.

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.

concrete

public boolean concrete()

Returns the value of the concrete record component.

Returns:

the value of the concrete record component

asyncReturnType

public boolean asyncReturnType()

Returns the value of the asyncReturnType record component.

Returns:

the value of the asyncReturnType record component

compilerGenerated

public boolean compilerGenerated()

Returns the value of the compilerGenerated record component.

Returns:

the value of the compilerGenerated record component

executionResultIgnored

public boolean executionResultIgnored()

Returns the value of the executionResultIgnored record component.

Returns:

the value of the executionResultIgnored record component

name

@NonNull
public @NonNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

returnType

@NonNull
public @NonNull Type returnType()

Returns the value of the returnType record component.

Returns:

the value of the returnType record component

unwrappedReturnType

@NonNull
public @NonNull Type unwrappedReturnType()

Returns the value of the unwrappedReturnType record component.

Returns:

the value of the unwrappedReturnType record component

parameterTypes

@NonNull
public @NonNull Type[] parameterTypes()

Returns the value of the parameterTypes record component.

Returns:

the value of the parameterTypes record component

methodType

@NonNull
public @NonNull MethodType methodType()

Returns the value of the methodType record component.

Returns:

the value of the methodType record component

definingClass

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

Returns the value of the definingClass record component.

Returns:

the value of the definingClass record component

executionTimeout

@Nullable
public @Nullable Duration executionTimeout()

Returns the value of the executionTimeout record component.

Returns:

the value of the executionTimeout record component

chainMetadata

@Nullable
public @Nullable RPCMethodMetadata.MethodChainMetadata chainMetadata()

Returns the value of the chainMetadata record component.

Returns:

the value of the chainMetadata record component