Package net.lucypoulton.squirtgun.command.context

Class StringContext

java.lang.Object

net.lucypoulton.squirtgun.command.context.StringContext

All Implemented Interfaces:

CommandContext

public class StringContext
extends Object
implements CommandContext

A command context that parses a raw string.

Constructor Summary

Constructors

Constructor	Description
StringContext(FormatProvider provider, PermissionHolder target, CommandNode<?> node, String value)

Method Summary

Modifier and Type	Method	Description
net.kyori.adventure.text.Component	execute()	Executes the command.
@Nullable Object	getArgumentValue(String name)	Gets the value of an argument by name.
<U> U	getArgumentValue(CommandArgument<U> name)	Gets the value of an argument.
@NotNull FormatProvider	getFormat()	Gets the format provider to use in message decoration.
String	getRaw()	Gets the raw input given to this context.
CommandNode<?>	getTail()	Gets the last node in the chain that has been reached.
PermissionHolder	getTarget()	Gets this command context's target.
List<String>	tabComplete()	Gets a list of entries for tab completion.

Methods inherited from class java.lang.Object

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

Constructor Details

StringContext

public StringContext(FormatProvider provider,
 PermissionHolder target,
 CommandNode<?> node,
 String value)

Method Details

getTarget

public PermissionHolder getTarget()

Description copied from interface: CommandContext

Gets this command context's target.

Specified by:

getTarget in interface CommandContext

getArgumentValue

@Nullable
public <U> U getArgumentValue(CommandArgument<U> name)

Description copied from interface: CommandContext

Gets the value of an argument.

Specified by:

getArgumentValue in interface CommandContext

Parameters:

name - the argument to get the value for

Returns:

the value if available - if unset then null

getArgumentValue

@Nullable
public @Nullable Object getArgumentValue(String name)

Description copied from interface: CommandContext

Gets the value of an argument by name.

Specified by:

getArgumentValue in interface CommandContext

Parameters:

name - the name of the argument to get the value for

Returns:

the value if available, if unset then null.

getRaw

public String getRaw()

Description copied from interface: CommandContext

Gets the raw input given to this context.

Specified by:

getRaw in interface CommandContext

getFormat

@NotNull
public @NotNull FormatProvider getFormat()

Description copied from interface: CommandContext

Gets the format provider to use in message decoration.

Specified by:

getFormat in interface CommandContext

tabComplete

public List<String> tabComplete()

Description copied from interface: CommandContext

Gets a list of entries for tab completion.

Specified by:

tabComplete in interface CommandContext

execute

public net.kyori.adventure.text.Component execute()

Description copied from interface: CommandContext

Executes the command.

Specified by:

execute in interface CommandContext

getTail

public CommandNode<?> getTail()

Description copied from interface: CommandContext

Gets the last node in the chain that has been reached.

Specified by:

getTail in interface CommandContext