revxrsal.commands.parameter

Enum CommandActorSenderResolver

java.lang.Object

java.lang.Enum<CommandActorSenderResolver>

revxrsal.commands.parameter.CommandActorSenderResolver

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommandActorSenderResolver>, SenderResolver<CommandActor>

@ApiStatus.Internal
public enum CommandActorSenderResolver
extends java.lang.Enum<CommandActorSenderResolver>
implements SenderResolver<CommandActor>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.Object	getSender(@NotNull java.lang.Class<?> customSenderType, @NotNull CommandActor actor, @NotNull ExecutableCommand<CommandActor> 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
static CommandActorSenderResolver	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommandActorSenderResolver[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final CommandActorSenderResolver INSTANCE

Method Detail

values

public static CommandActorSenderResolver[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommandActorSenderResolver c : CommandActorSenderResolver.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommandActorSenderResolver valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isSenderType

public boolean isSenderType(@NotNull
                            @NotNull CommandParameter parameter)

Description copied from interface: SenderResolver

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

Specified by:

isSenderType in interface SenderResolver<CommandActor>

Parameters:

parameter - Type to test

Returns:

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

getSender

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

Description copied from interface: SenderResolver

Returns the custom sender value from the given context

Specified by:

getSender in interface SenderResolver<CommandActor>

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.