revxrsal.commands.process

Interface SenderResolver<A extends CommandActor>

All Known Implementing Classes:

CommandActorSenderResolver

public interface SenderResolver<A extends CommandActor>

Represents a special resolver for parameters that are always first in command methods. These parameters can be treated as referring to the command actor.

Registering a custom sender resolver allows using certain types as senders. The custom types must be tested inside isSenderType(CommandParameter), and it is recommended to use CustomType.class.isAssignableFrom(type) to make sure subclasses are respected.

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.Object	getSender(@NotNull java.lang.Class<?> customSenderType, A actor, @NotNull ExecutableCommand<A> command) Returns the custom sender value from the given context
boolean	isSenderType(@NotNull CommandParameter parameter) Tests whether is the specified type a custom sender type or not

Method Detail

isSenderType

boolean isSenderType(@NotNull
                     @NotNull CommandParameter parameter)

Tests whether is the specified type a custom sender type or not

Parameters:

parameter - Type to test

Returns:

True if it is a custom type, false if otherwise.

getSender

@NotNull
@NotNull java.lang.Object getSender(@NotNull
                                             @NotNull java.lang.Class<?> customSenderType,
                                             @NotNull
                                             A actor,
                                             @NotNull
                                             @NotNull ExecutableCommand<A> command)

Returns the custom sender value from the given context

Parameters:

customSenderType - The type of the custom sender. This matches the command parameter type.

actor - The command actor

command - The command being executed

Returns:

The custom sender value. This must not be null.