Package org.incendo.cloud.context

Class CommandContext<C>

java.lang.Object

org.incendo.cloud.context.CommandContext<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

CloudKeyContainer, MutableCloudKeyContainer

@API(status=STABLE)
public class CommandContext<C>
extends Object
implements MutableCloudKeyContainer

Command context used to assist in the parsing of commands

Constructor Summary

Constructors

Constructor	Description
CommandContext(boolean suggestions, @NonNull C commandSender, @NonNull CommandManager<C> commandManager)	Creates a new command context instance.
CommandContext(@NonNull C commandSender, @NonNull CommandManager<C> commandManager)	Creates a new command context instance.

Method Summary

Modifier and Type	Method	Description
final @NonNull Map<CloudKey<?>,? extends @NonNull Object>	all()	Returns all stored values.
@NonNull Command<C>	command()	Returns the current Command.
void	command(@NonNull Command<C> command)	Sets the current Command.
<T> T	computeIfAbsent(@NonNull CloudKey<T> key, @NonNull Function<CloudKey<T>,T> defaultFunction)	Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.
boolean	contains(@NonNull CloudKey<?> key)	Returns whether the registry contains a value associated with the given key.
@NonNull ParsingContext<C>	createParsingContext(@NonNull CommandComponent<C> component)	Creates a parsing context instance for the given component.
@NonNull FlagContext	flags()	Returns the associated FlagContext instance.
<T> @NonNull T	formatCaption(@NonNull CaptionFormatter<C,T> formatter, @NonNull Caption caption, @NonNull List<@NonNull CaptionVariable> variables)	Formats a caption using the given formatter.
<T> @NonNull T	formatCaption(@NonNull CaptionFormatter<C,T> formatter, @NonNull Caption caption, @NonNull CaptionVariable @NonNull ... variables)	Formats a caption using the given formatter.
@NonNull String	formatCaption(@NonNull Caption caption, @NonNull List<@NonNull CaptionVariable> variables)	Formats a caption using the CommandManager.captionFormatter().
@NonNull String	formatCaption(@NonNull Caption caption, @NonNull CaptionVariable @NonNull ... variables)	Formats a caption using the CommandManager.captionFormatter().
boolean	hasPermission(@NonNull String permission)	Checks whether the sender that executed the command has a permission.
boolean	hasPermission(@NonNull Permission permission)	Checks whether the sender that executed the command has a permission.
<T> @NonNull Optional<T>	inject(@NonNull TypeToken<T> type)	Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.
<T> @NonNull Optional<T>	inject(@NonNull Class<T> clazz)	Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.
boolean	isSuggestions()	Checks if this context was created for tab completion purposes.
<T extends @NonNull Object> @NonNull Optional<T>	optional(@NonNull String key)	Returns the value associated with the given key.
<T extends @NonNull Object> @NonNull Optional<T>	optional(@NonNull CloudKey<T> key)	Returns the value associated with the given key.
@NonNull ParsingContext<C>	parsingContext(int position)	Returns the context for the component at the given position.
@NonNull ParsingContext<C>	parsingContext(String name)	Returns the context for the component with the given name.
@NonNull ParsingContext<C>	parsingContext(@NonNull CommandComponent<C> component)	Returns the context for the given component.
@NonNull List<@NonNull ParsingContext<@NonNull C>>	parsingContexts()	Returns an unmodifiable view of the stored parsing contexts.
@NonNull CommandInput	rawInput()	Returns a copy of the raw input.
void	remove(@NonNull CloudKey<?> key)	Removes value associated with the given key.
@NonNull C	sender()	Returns the sender that executed the command.
<T extends @NonNull Object> void	store(@NonNull String key, T value)	Stores the key-value pair.
<T extends @NonNull Object> void	store(@NonNull CloudKey<T> key, T value)	Stores the key-value pair.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.key.CloudKeyContainer

contains, contains, get, get, get, getOrDefault, getOrDefault, getOrDefault, getOrSupplyDefault, getOrSupplyDefault, getOrSupplyDefault, optional

Methods inherited from interface org.incendo.cloud.key.MutableCloudKeyContainer

computeIfAbsent, remove, remove, set, set, set, store

Constructor Details

CommandContext

@API(status=STABLE)
public CommandContext(@NonNull C commandSender,
 @NonNull CommandManager<C> commandManager)

Creates a new command context instance.

Parameters:

commandSender - the sender of the command

commandManager - command manager

CommandContext

@API(status=STABLE)
public CommandContext(boolean suggestions,
 @NonNull C commandSender,
 @NonNull CommandManager<C> commandManager)

Creates a new command context instance.

Parameters:

suggestions - whether the context is created for command suggestions

commandSender - the sender of the command

commandManager - command manager

Method Details

formatCaption

public @NonNull String formatCaption(@NonNull Caption caption,
 @NonNull CaptionVariable @NonNull ... variables)

Formats a caption using the CommandManager.captionFormatter().

Parameters:

caption - the caption key

variables - the variables to use during formatting

Returns:

the formatted caption

formatCaption

public @NonNull String formatCaption(@NonNull Caption caption,
 @NonNull List<@NonNull CaptionVariable> variables)

Formats a caption using the CommandManager.captionFormatter().

Parameters:

caption - the caption key

variables - the variables to use during formatting

Returns:

the formatted caption

formatCaption

public <T> @NonNull T formatCaption(@NonNull CaptionFormatter<C,T> formatter,
 @NonNull Caption caption,
 @NonNull CaptionVariable @NonNull ... variables)

Formats a caption using the given formatter.

Type Parameters:

T - the message type produced by the formatter

Parameters:

formatter - the formatter

caption - the caption key

variables - the variables to use during formatting

Returns:

the formatted caption

formatCaption

public <T> @NonNull T formatCaption(@NonNull CaptionFormatter<C,T> formatter,
 @NonNull Caption caption,
 @NonNull List<@NonNull CaptionVariable> variables)

Formats a caption using the given formatter.

Type Parameters:

T - the message type produced by the formatter

Parameters:

formatter - the formatter

caption - the caption key

variables - the variables to use during formatting

Returns:

the formatted caption

sender

@API(status=STABLE)
public @NonNull C sender()

Returns the sender that executed the command.

Returns:

the command sender

hasPermission

@API(status=STABLE)
public boolean hasPermission(@NonNull Permission permission)

Checks whether the sender that executed the command has a permission.

Parameters:

permission - the permission

Returns:

true if the sender() has the permission, else false

hasPermission

@API(status=STABLE)
public boolean hasPermission(@NonNull String permission)

Checks whether the sender that executed the command has a permission.

Parameters:

permission - the permission

Returns:

true if the sender() has the permission, else false

isSuggestions

public boolean isSuggestions()

Checks if this context was created for tab completion purposes.

Returns:

true if this context is requesting suggestions, else false

store

public <T extends @NonNull Object> void store(@NonNull String key,
 T value)

Stores the key-value pair.

This will overwrite any existing value stored with the same key.

Specified by:

store in interface MutableCloudKeyContainer

Type Parameters:

T - the type of the value

Parameters:

key - the key

value - the value

store

public <T extends @NonNull Object> void store(@NonNull CloudKey<T> key,
 T value)

Stores the key-value pair.

This will overwrite any existing value stored with the same key.

Specified by:

store in interface MutableCloudKeyContainer

Type Parameters:

T - the type of the value

Parameters:

key - the key

value - the value

contains

public boolean contains(@NonNull CloudKey<?> key)

Returns whether the registry contains a value associated with the given key.

Specified by:

contains in interface CloudKeyContainer

Parameters:

key - the key

Returns:

true if the value exists, or false if it does not

optional

public <T extends @NonNull Object>
@NonNull Optional<T> optional(@NonNull CloudKey<T> key)

Returns the value associated with the given key.

Specified by:

optional in interface CloudKeyContainer

Type Parameters:

T - the type of the value

Parameters:

key - the key

Returns:

the value

optional

public <T extends @NonNull Object>
@NonNull Optional<T> optional(@NonNull String key)

Returns the value associated with the given key.

Specified by:

optional in interface CloudKeyContainer

Type Parameters:

T - the type of the value

Parameters:

key - the key

Returns:

the value

remove

public void remove(@NonNull CloudKey<?> key)

Removes value associated with the given key.

Specified by:

remove in interface MutableCloudKeyContainer

Parameters:

key - the key

computeIfAbsent

public <T> T computeIfAbsent(@NonNull CloudKey<T> key,
 @NonNull Function<CloudKey<T>,T> defaultFunction)

Returns the value associated with the given key if it exists, else computes and stores the value returned by the given defaultFunction and then returns it.

Specified by:

computeIfAbsent in interface MutableCloudKeyContainer

Type Parameters:

T - the type of the value

Parameters:

key - the key

defaultFunction - the function used to generate the value in case it's missing

Returns:

the present or computed value

rawInput

@API(status=STABLE)
public @NonNull CommandInput rawInput()

Returns a copy of the raw input.

Returns:

raw input

createParsingContext

@API(status=MAINTAINED)
public @NonNull ParsingContext<C> createParsingContext(@NonNull CommandComponent<C> component)

Creates a parsing context instance for the given component.

Parameters:

component - the component

Returns:

the created context

parsingContext

@API(status=MAINTAINED)
public @NonNull ParsingContext<C> parsingContext(@NonNull CommandComponent<C> component)

Returns the context for the given component.

Parameters:

component - the component

Returns:

the context

parsingContext

@API(status=MAINTAINED)
public @NonNull ParsingContext<C> parsingContext(int position)

Returns the context for the component at the given position.

Parameters:

position - the position

Returns:

the context

parsingContext

@API(status=MAINTAINED)
public @NonNull ParsingContext<C> parsingContext(String name)

Returns the context for the component with the given name.

Parameters:

name - the name

Returns:

the context

parsingContexts

@API(status=MAINTAINED)
public @NonNull List<@NonNull ParsingContext<@NonNull C>> parsingContexts()

Returns an unmodifiable view of the stored parsing contexts.

Returns:

the contexts

flags

public @NonNull FlagContext flags()

Returns the associated FlagContext instance.

Returns:

flag context

command

public @NonNull Command<C> command()

Returns the current Command. This is only available from CommandExecutionHandlers and CommandPostprocessors.

Returns:

the current command

command

@API(status=INTERNAL)
public void command(@NonNull Command<C> command)

Sets the current Command.

Parameters:

command - the command

inject

@API(status=STABLE)
public <T> @NonNull Optional<T> inject(@NonNull Class<T> clazz)

Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.

Type Parameters:

T - type to inject

Parameters:

clazz - class of type to inject

Returns:

optional that may contain the created value

inject

@API(status=STABLE)
public <T> @NonNull Optional<T> inject(@NonNull TypeToken<T> type)

Attempts to retrieve a value that has been registered to the associated command manager's ParameterInjectorRegistry.

Type Parameters:

T - type to inject

Parameters:

type - type to inject

Returns:

optional that may contain the created value

all

public final @NonNull Map<CloudKey<?>,? extends @NonNull Object> all()

Description copied from interface: CloudKeyContainer

Returns all stored values.

Specified by:

all in interface CloudKeyContainer

Returns:

immutable view of all values