revxrsal.commands.node

Interface ExecutionContext<A extends CommandActor>

Type Parameters:

A - The actor type

All Known Subinterfaces:

MutableExecutionContext<A>

public interface ExecutionContext<A extends CommandActor>

Represents the context of the execution of the command.

Method Summary

Modifier and Type	Method and Description
A	actor() Returns the actor executing this command
@NotNull ExecutableCommand<A>	command() Returns the command being executed
static <A extends CommandActor> @NotNull ExecutionContext<A>	create(@NotNull ExecutableCommand<A> command, A actor, @NotNull StringStream input) Creates a new MutableExecutionContext for the given command, actor and input.
static <A extends CommandActor> @NotNull MutableExecutionContext<A>	createMutable(@NotNull ExecutableCommand<A> command, A actor, @NotNull StringStream input) Creates a new MutableExecutionContext for the given command, actor and input.
default <T> T	getResolvedArgument(@NotNull java.lang.Class<T> argumentType) Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.
default <T> T	getResolvedArgument(@NotNull java.lang.String argumentName) Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.
<T> T	getResolvedArgumentOrNull(@NotNull java.lang.Class<T> argumentType) Returns the first argument that matches the given type
<T> T	getResolvedArgumentOrNull(@NotNull java.lang.String argumentName) Returns the argument that has been resolved with the given name
@NotNull StringStream	input() Returns the underlying StringStream of this context.
@NotNull Lamp<A>	lamp() Returns the Lamp instance that is executing this command
@NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object>	resolvedArguments() Returns the arguments that have been resolved, each mapped to the parameter name.

Method Detail

createMutable

@Contract(value="_,_,_ -> new")
 @NotNull
static <A extends CommandActor> @NotNull MutableExecutionContext<A> createMutable(@NotNull
                                                                                                                            @NotNull ExecutableCommand<A> command,
                                                                                                                            @NotNull
                                                                                                                            A actor,
                                                                                                                            @NotNull
                                                                                                                            @NotNull StringStream input)

Creates a new MutableExecutionContext for the given command, actor and input. This can be modified and used to generate execution contexts from different platforms.

Type Parameters:

A - The actor type

Parameters:

command - The executed command

actor - The actor executing the command

input - The command input.

Returns:

The context

create

@Contract(value="_,_,_ -> new")
 @NotNull
static <A extends CommandActor> @NotNull ExecutionContext<A> create(@NotNull
                                                                                                              @NotNull ExecutableCommand<A> command,
                                                                                                              @NotNull
                                                                                                              A actor,
                                                                                                              @NotNull
                                                                                                              @NotNull StringStream input)

Creates a new MutableExecutionContext for the given command, actor and input. This can be modified and used to generate execution contexts from different platforms.

Type Parameters:

A - The actor type

Parameters:

command - The executed command

actor - The actor executing the command

input - The command input.

Returns:

The context

actor

@NotNull
A actor()

Returns the actor executing this command

Returns:

The actor

lamp

@NotNull
@NotNull Lamp<A> lamp()

Returns the Lamp instance that is executing this command

Returns:

The Lamp instance

command

@NotNull
@NotNull ExecutableCommand<A> command()

Returns the command being executed

Returns:

The executed command

resolvedArguments

@NotNull
@NotNull @UnmodifiableView java.util.Map<java.lang.String,java.lang.Object> resolvedArguments()

Returns the arguments that have been resolved, each mapped to the parameter name.

Returns:

The arguments that have been resolved

input

@NotNull
@NotNull StringStream input()

Returns the underlying StringStream of this context. Note that this may not always be in the expected format, as it is generated from a platform-specific format.

Returns:

The string stream

getResolvedArgumentOrNull

@Nullable
<T> T getResolvedArgumentOrNull(@NotNull
                                          @NotNull java.lang.String argumentName)

Returns the argument that has been resolved with the given name

Type Parameters:

T - The parameter type

Parameters:

argumentName - The argument name

Returns:

The parameter, or null if it was not resolved

getResolvedArgumentOrNull

@Nullable
<T> T getResolvedArgumentOrNull(@NotNull
                                          @NotNull java.lang.Class<T> argumentType)

Returns the first argument that matches the given type

Type Parameters:

T - The parameter type

Parameters:

argumentType - The argument type

Returns:

The parameter, or null if it was not resolved

getResolvedArgument

@NotNull
default <T> T getResolvedArgument(@NotNull
                                           @NotNull java.lang.String argumentName)

Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.

Type Parameters:

T - The parameter type

Parameters:

argumentName - The argument name

Returns:

The parameter

Throws:

java.lang.IllegalArgumentException - if no such parameter found

getResolvedArgument

@NotNull
default <T> T getResolvedArgument(@NotNull
                                           @NotNull java.lang.Class<T> argumentType)

Returns the first argument that matches the given type, or throws an IllegalArgumentException if not found.

Type Parameters:

T - The parameter type

Parameters:

argumentType - The argument type

Returns:

The parameter

Throws:

java.lang.IllegalArgumentException - if no such parameter found