Enum Class RPCInternalInstanceFactory.SpecialArg

java.lang.Object

java.lang.Enum<RPCInternalInstanceFactory.SpecialArg>

eu.cloudnetservice.driver.impl.network.rpc.generation.RPCInternalInstanceFactory.SpecialArg

All Implemented Interfaces:

Serializable, Comparable<RPCInternalInstanceFactory.SpecialArg>, Constable

Enclosing class:

RPCInternalInstanceFactory

public static enum RPCInternalInstanceFactory.SpecialArg
extends Enum<RPCInternalInstanceFactory.SpecialArg>

A collection of special args that can be passed to a super constructor when invoking. If the extra argument array on an instance construct call contains this enum, the value is replaced with the value passed to the instance factory.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL_SUPPLIER	The channel supplier to get the channel into which the rpc calls should be sent.
RPC_CHAIN_BASE	The base rpc used for the class invocation, can be null.
RPC_SENDER	Special pointer that will be replaced with the rpc sender responsible for the target class.

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<?>	argType
static final int	SPECIAL_ARG_MAX_INDEX
private static final RPCInternalInstanceFactory.SpecialArg[]	VALUES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SpecialArg(@NonNull Class<?> argType)	Constructs a new special arg.

Method Summary

Modifier and Type	Method	Description
(package private) @NonNull Class<?>	argType()	Get the argument type that will be injected into the constructor.
(package private) static @NonNull RPCInternalInstanceFactory.SpecialArg	fromParamMappingIndex(int paramMappingIndex)	Get the special argument represented by the given param mapping index or throws an exception if the param mapping index is invalid.
static RPCInternalInstanceFactory.SpecialArg	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RPCInternalInstanceFactory.SpecialArg[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RPC_SENDER

public static final RPCInternalInstanceFactory.SpecialArg RPC_SENDER

Special pointer that will be replaced with the rpc sender responsible for the target class.

RPC_CHAIN_BASE

public static final RPCInternalInstanceFactory.SpecialArg RPC_CHAIN_BASE

The base rpc used for the class invocation, can be null.

CHANNEL_SUPPLIER

public static final RPCInternalInstanceFactory.SpecialArg CHANNEL_SUPPLIER

The channel supplier to get the channel into which the rpc calls should be sent.

Field Details

VALUES

private static final RPCInternalInstanceFactory.SpecialArg[] VALUES

SPECIAL_ARG_MAX_INDEX

public static final int SPECIAL_ARG_MAX_INDEX

argType

private final Class<?> argType

Constructor Details

SpecialArg

private SpecialArg(@NonNull
 @NonNull Class<?> argType)

Constructs a new special arg.

Parameters:

argType - the type that will be injected in the final step.

Throws:

NullPointerException - if the given arg type is null.

Method Details

values

public static RPCInternalInstanceFactory.SpecialArg[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RPCInternalInstanceFactory.SpecialArg valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromParamMappingIndex

@NonNull
static @NonNull RPCInternalInstanceFactory.SpecialArg fromParamMappingIndex(int paramMappingIndex)

Get the special argument represented by the given param mapping index or throws an exception if the param mapping index is invalid.

Parameters:

paramMappingIndex - the param mapping index to get the special arg for.

Returns:

the special arg mapped to the given param mapping index.

Throws:

IllegalStateException - if the given param mapping value is invalid.

argType

@NonNull
@NonNull Class<?> argType()

Get the argument type that will be injected into the constructor.

Returns:

the argument type that will be injected into the constructor.