revxrsal.commands.command

Interface CommandFunction

public interface CommandFunction

Represents a function that contains an executable command. This corresponds to a reflection Method.

Method Summary

Modifier and Type	Method and Description
@NotNull AnnotationList	annotations() Returns the annotations on the function
<T> T	call(java.lang.Object... arguments) Calls the function with the given arguments
@NotNull MethodCaller.BoundMethodCaller	caller() Returns a wrapper that allows to easily invoke the method with its parameters directly.
default <T extends java.lang.annotation.Annotation> T	getAnnotation(@NotNull java.lang.Class<T> type) Returns the annotation on the function
default boolean	hasAnnotation(@NotNull java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Tests whether the function has the specified annotation
<A extends CommandActor> Lamp<A>	lamp() Returns the Lamp instance that created this function.
@NotNull java.lang.reflect.Method	method() Returns the underlying Method of this function
@NotNull java.lang.String	name() Returns the function name
@NotNull CommandParameter	parameter(java.lang.String name) Returns the CommandParameter that has a given name, otherwise throws an error.
@NotNull @Unmodifiable java.util.Map<java.lang.String,CommandParameter>	parametersByName() Returns an unmodifiable map of the parameters this function contains.
<T> @NotNull ResponseHandler<?,T>	responseHandler() Returns the response handler for this function

Method Detail

lamp

<A extends CommandActor> Lamp<A> lamp()

Returns the Lamp instance that created this function.

Returns:

The lamp instance

name

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

Returns the function name

Returns:

The function name

annotations

@NotNull
@NotNull AnnotationList annotations()

Returns the annotations on the function

Returns:

The function annotations

method

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

Returns the underlying Method of this function

Returns:

The method

parametersByName

@NotNull
@NotNull @Unmodifiable java.util.Map<java.lang.String,CommandParameter> parametersByName()

Returns an unmodifiable map of the parameters this function contains.

Note that the names are the ones generated by ParameterNamingStrategy or explicitly set with Named, and not Parameter.getName().

Returns:

A map of the parameters by their names

parameter

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

Returns the CommandParameter that has a given name, otherwise throws an error.

Parameters:

name - Name of the parameter

Returns:

The parameter

Throws:

java.util.NoSuchElementException - if no such parameter exists

caller

@NotNull
@NotNull MethodCaller.BoundMethodCaller caller()

Returns a wrapper that allows to easily invoke the method with its parameters directly.

Returns:

The method caller

call

<T> T call(@NotNull
           java.lang.Object... arguments)

Calls the function with the given arguments

Type Parameters:

T - The function return type

Parameters:

arguments - Arguments to invoke with

Returns:

The function return result

responseHandler

@NotNull
<T> @NotNull ResponseHandler<?,T> responseHandler()

Returns the response handler for this function

Type Parameters:

T - The response type

Returns:

The response handler

hasAnnotation

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

Tests whether the function has the specified annotation

Parameters:

annotationType - Annotation to check for

Returns:

whether the function has the given annotation or not

getAnnotation

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

Returns the annotation on the function

Parameters:

type - Annotation to check for

Returns:

The annotation value, or null if it's not present.