me.vaperion.blade.context

Class Context

java.lang.Object

me.vaperion.blade.context.Context

public final class Context
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Context(Blade blade, Sender<?> sender, java.lang.String label, java.lang.String[] arguments)

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	argument(int index) Gets the argument at the specified index.
@NotNull java.lang.String[]	arguments() Gets all provided arguments.
@NotNull Blade	blade() The Blade instance.
@NotNull java.lang.String	label() The label that was used to invoke the command.
Context	label(java.lang.String label)
<T> T	parseArgument(int index, @NotNull ArgumentProvider<T> provider) Attempts to parse the argument at the specified index using the provided argument provider.
<T> T	parseArgument(int index, @NotNull ArgumentProvider<T> provider, @NotNull java.lang.String defaultValue) Attempts to parse the argument at the specified index using the provided argument provider and default value.
<T> T	parseArgument(int index, @NotNull java.lang.Class<T> argumentClass) Attempts to parse the argument at the specified index using the provided argument class.
<T> T	parseArgument(int index, @NotNull java.lang.Class<T> classOfT, @NotNull ArgumentProvider<T> provider, @NotNull java.lang.String defaultValue) Attempts to parse the argument at the specified index using the provided argument class and provider.
<T> T	parseArgument(int index, @NotNull java.lang.Class<T> argumentClass, @NotNull java.lang.String defaultValue) Attempts to parse the argument at the specified index using the provided argument class and default value.
@NotNull Sender<?>	sender() The sender of the command.
void	updateArgumentsFromInput(@NotNull CommandInput input) Updates the arguments from the given command input.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(Blade blade,
               Sender<?> sender,
               java.lang.String label,
               java.lang.String[] arguments)

Method Detail

arguments

@NotNull
public @NotNull java.lang.String[] arguments()

Gets all provided arguments.

Returns:

the arguments

argument

@Nullable
public @Nullable java.lang.String argument(int index)

Gets the argument at the specified index.

Parameters:

index - the index

Returns:

the argument, or null if not present

parseArgument

@Nullable
public <T> T parseArgument(int index,
                                     @NotNull
                                     @NotNull java.lang.Class<T> argumentClass)

Attempts to parse the argument at the specified index using the provided argument class.

Type Parameters:

T - the type of the argument

Parameters:

index - the index

argumentClass - the argument class

Returns:

the parsed argument, or null if not present

parseArgument

@Nullable
public <T> T parseArgument(int index,
                                     @NotNull
                                     @NotNull java.lang.Class<T> argumentClass,
                                     @NotNull
                                     @NotNull java.lang.String defaultValue)

Attempts to parse the argument at the specified index using the provided argument class and default value.

Type Parameters:

T - the type of the argument

Parameters:

index - the index

argumentClass - the argument class

defaultValue - the default value to use if the argument is not present

Returns:

the parsed argument, or the default value if not present

parseArgument

@Nullable
public <T> T parseArgument(int index,
                                     @NotNull
                                     @NotNull ArgumentProvider<T> provider)

Attempts to parse the argument at the specified index using the provided argument provider.

Type Parameters:

T - the type of the argument

Parameters:

index - the index

provider - the argument provider

Returns:

the parsed argument, or null if not present

parseArgument

@Nullable
public <T> T parseArgument(int index,
                                     @NotNull
                                     @NotNull ArgumentProvider<T> provider,
                                     @NotNull
                                     @NotNull java.lang.String defaultValue)

Attempts to parse the argument at the specified index using the provided argument provider and default value.

Type Parameters:

T - the type of the argument

Parameters:

index - the index

provider - the argument provider

defaultValue - the default value to use if the argument is not present

Returns:

the parsed argument, or the default value if not present

parseArgument

@Nullable
public <T> T parseArgument(int index,
                                     @NotNull
                                     @NotNull java.lang.Class<T> classOfT,
                                     @NotNull
                                     @NotNull ArgumentProvider<T> provider,
                                     @NotNull
                                     @NotNull java.lang.String defaultValue)

Attempts to parse the argument at the specified index using the provided argument class and provider.

Type Parameters:

T - the type of the argument

Parameters:

index - the index

classOfT - the argument class

provider - the argument provider

defaultValue - the default value to use if the argument is not present

Returns:

the parsed argument, or the default value if not present

label

@NotNull
public @NotNull java.lang.String label()

The label that was used to invoke the command.

Returns:

the label

sender

@NotNull
public @NotNull Sender<?> sender()

The sender of the command.

Returns:

the sender

blade

@NotNull
public @NotNull Blade blade()

The Blade instance.

Returns:

the blade instance

updateArgumentsFromInput

@ApiStatus.Internal
public void updateArgumentsFromInput(@NotNull
                                                         @NotNull CommandInput input)

Updates the arguments from the given command input.

Parameters:

input - the command input

label

@ApiStatus.Internal
public Context label(java.lang.String label)

Returns:

this.