revxrsal.commands.command

Interface CommandParameter

public interface CommandParameter

Represents a parameter in a command. This corresponds to a reflection Parameter.

Method Summary

Modifier and Type	Method and Description
@NotNull AnnotationList	annotations() Returns the list of annotations present on this parameter.
@NotNull java.lang.reflect.Type	fullType() Returns the full type of the parameter, including generics.
@NotNull java.util.List<java.lang.reflect.Type>	generics() Returns a list of generic types associated with this parameter.
default <T extends java.lang.annotation.Annotation> T	getAnnotation(@NotNull java.lang.Class<T> type) Returns the given annotation, or null if it's not annotated with the given annotation (or distributed on, indirectly)
default boolean	hasAnnotation(@NotNull java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Tests whether this parameter has the given annotation or not
boolean	isLastInMethod() Tests whether is this parameter the last in the method or not
boolean	isOptional() Tests whether is this parameter optional or not.
@NotNull java.lang.reflect.Method	method() Returns the method associated with this parameter.
int	methodIndex() Returns the index of this parameter in the method.
@NotNull java.lang.String	name() Returns the name of the parameter.
@NotNull java.lang.reflect.Parameter	parameter() Returns the underlying Parameter
@NotNull java.lang.Class<?>	type() Returns the raw class type of the parameter.

Method Detail

name

@NotNull
@NotNull java.lang.String name()

Returns the name of the parameter. Note that this may not always be equal to the name of the underlying parameter, as it could be generated by a ParameterNamingStrategy or overridden explicitly using @Named

Returns:

The parameter name

methodIndex

int methodIndex()

Returns the index of this parameter in the method.

Returns:

The index of this parameter in the method.

isLastInMethod

boolean isLastInMethod()

Tests whether is this parameter the last in the method or not

Returns:

If this parameter is the last

parameter

@NotNull
@NotNull java.lang.reflect.Parameter parameter()

Returns the underlying Parameter

Returns:

The underlying parameter

method

@NotNull
@NotNull java.lang.reflect.Method method()

Returns the method associated with this parameter.

Returns:

The method associated with this parameter.

annotations

@NotNull
@NotNull AnnotationList annotations()

Returns the list of annotations present on this parameter.

Returns:

A list of annotations present on this parameter.

type

@NotNull
@NotNull java.lang.Class<?> type()

Returns the raw class type of the parameter.

Returns:

The raw class type of the parameter.

fullType

@NotNull
@NotNull java.lang.reflect.Type fullType()

Returns the full type of the parameter, including generics.

Returns:

The full type of the parameter.

generics

@NotNull
@NotNull java.util.List<java.lang.reflect.Type> generics()

Returns a list of generic types associated with this parameter.

If this parameter is not parameterized, this will be an empty list.

Returns:

A list of generic types associated with this parameter.

isOptional

boolean isOptional()

Tests whether is this parameter optional or not.

This will return true in these cases:

1. It is marked with @Optional
2. It has a default value from @Default
3. It has @Sized with min() == 0

Returns:

if this parameter is optional

hasAnnotation

default boolean hasAnnotation(@NotNull
                              @NotNull java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Tests whether this parameter has the given annotation or not

Parameters:

annotationType - The annotation type to check for

Returns:

true if the annotation is present, false if otherwise.

getAnnotation

@Nullable
default <T extends java.lang.annotation.Annotation> T getAnnotation(@NotNull
                                                                              @NotNull java.lang.Class<T> type)

Returns the given annotation, or null if it's not annotated with the given annotation (or distributed on, indirectly)

Type Parameters:

T - The annotation type automatically cast

Parameters:

type - The annotation type

Returns:

The annotation instance, or null if not present