me.vaperion.blade.command

Class BladeCommand

java.lang.Object

me.vaperion.blade.command.BladeCommand

public final class BladeCommand
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BladeCommand(@NotNull Blade blade, @Nullable java.lang.Object instance, @NotNull java.lang.reflect.Method method)

Method Summary

Modifier and Type	Method and Description
boolean	anyLabelStartsWith(@NotNull java.lang.String input) Checks if any of the command's labels start with the given input string.
java.util.List<ArgumentProvider<?>>	argumentProviders()
@NotNull java.util.List<DefinedArgument>	arguments() Get all argument parameters.
boolean	async()
java.lang.String[]	baseCommands()
Blade	blade()
java.lang.String	customUsage()
java.lang.String	description()
java.lang.String	extraUsageData()
java.util.List<ArgumentProvider<?>>	flagProviders()
@NotNull java.util.List<DefinedFlag>	flags() Get all flag parameters.
boolean	hasPermission(@NotNull Context context) Checks if the given context has permission to execute this command.
boolean	hasSenderParameter()
boolean	helpCommand()
@NotNull CommandFeedback<?>	helpMessage() Gets or loads the help message for this command.
boolean	hidden()
java.lang.Object	instance()
java.lang.String[]	labels()
java.lang.String	mainLabel()
java.lang.reflect.Method	method()
java.util.List<BladeParameter>	parameters()
boolean	parseQuotes()
java.lang.String	permission()
java.lang.String	permissionMessage()
java.util.List<ArgumentProvider<?>>	rawProviderList()
java.util.List<SndProvider<?>>	senderProviders()
java.lang.Class<?>	senderType()
@NotNull CommandInput	tokenize(@NotNull Sender<?> sender, @NotNull java.lang.String input, InputOption... options) Tokenizes the given input string according to this command's parameters.
java.lang.String	toString()
@NotNull CommandFeedback<?>	usageMessage() Gets or loads the usage message for this command.
boolean	usesBladeContext()
boolean	usesBladeSender()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BladeCommand

public BladeCommand(@NotNull
                    @NotNull Blade blade,
                    @Nullable
                    @Nullable java.lang.Object instance,
                    @NotNull
                    @NotNull java.lang.reflect.Method method)

Method Detail

usageMessage

@NotNull
public @NotNull CommandFeedback<?> usageMessage()

Gets or loads the usage message for this command.

Returns:

the usage message

helpMessage

@NotNull
public @NotNull CommandFeedback<?> helpMessage()

Gets or loads the help message for this command.

Returns:

the help message

anyLabelStartsWith

public boolean anyLabelStartsWith(@NotNull
                                  @NotNull java.lang.String input)

Checks if any of the command's labels start with the given input string.

Parameters:

input - the string to check

Returns:

true if any label starts with the input string, false otherwise

hasPermission

public boolean hasPermission(@NotNull
                             @NotNull Context context)

Checks if the given context has permission to execute this command.

Parameters:

context - the command context

Returns:

true if the context has permission, false otherwise

tokenize

@NotNull
public @NotNull CommandInput tokenize(@NotNull
                                               @NotNull Sender<?> sender,
                                               @NotNull
                                               @NotNull java.lang.String input,
                                               @NotNull
                                               InputOption... options)

Tokenizes the given input string according to this command's parameters.

Parameters:

sender - the sender executing the command

input - the input string to tokenize

options - the input options to use during tokenization

Returns:

the tokenized command input

arguments

@NotNull
public @NotNull java.util.List<DefinedArgument> arguments()

Get all argument parameters.

Returns:

a list of argument parameters

flags

@NotNull
public @NotNull java.util.List<DefinedFlag> flags()

Get all flag parameters.

Returns:

a list of flag parameters

blade

public Blade blade()

instance

public java.lang.Object instance()

method

public java.lang.reflect.Method method()

labels

public java.lang.String[] labels()

baseCommands

public java.lang.String[] baseCommands()

description

public java.lang.String description()

mainLabel

public java.lang.String mainLabel()

customUsage

public java.lang.String customUsage()

extraUsageData

public java.lang.String extraUsageData()

permission

public java.lang.String permission()

permissionMessage

public java.lang.String permissionMessage()

async

public boolean async()

parseQuotes

public boolean parseQuotes()

hidden

public boolean hidden()

helpCommand

public boolean helpCommand()

hasSenderParameter

public boolean hasSenderParameter()

usesBladeContext

public boolean usesBladeContext()

usesBladeSender

public boolean usesBladeSender()

senderType

public java.lang.Class<?> senderType()

parameters

public java.util.List<BladeParameter> parameters()

rawProviderList

public java.util.List<ArgumentProvider<?>> rawProviderList()

argumentProviders

public java.util.List<ArgumentProvider<?>> argumentProviders()

flagProviders

public java.util.List<ArgumentProvider<?>> flagProviders()

senderProviders

public java.util.List<SndProvider<?>> senderProviders()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object