org.spongepowered.api.command.args

Class CommandElement

java.lang.Object

org.spongepowered.api.command.args.CommandElement

Direct Known Subclasses:

ChildCommandElementExecutor, CommandFlags, PatternMatchingCommandElement

public abstract class CommandElement
extends Object

Represents a command argument element.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandElement(Text key)

Method Summary

Modifier and Type	Method and Description
abstract List<String>	complete(CommandSource src, CommandArgs args, CommandContext context) Fetch completions for command arguments.
Text	getKey() Return the key to be used for this object.
String	getUntranslatedKey() Return the plain key, to be used when looking up this command element in a CommandContext.
Text	getUsage(CommandSource src) Return a usage message for this specific argument.
void	parse(CommandSource source, CommandArgs args, CommandContext context) Attempt to extract a value for this element from the given arguments and put it in the given context.
protected abstract Object	parseValue(CommandSource source, CommandArgs args) Attempt to extract a value for this element from the given arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandElement

protected CommandElement(@Nullable
                         Text key)

Method Detail

getKey

@Nullable
public Text getKey()

Return the key to be used for this object.

Returns:

the user-facing representation of the key

getUntranslatedKey

@Nullable
public String getUntranslatedKey()

Return the plain key, to be used when looking up this command element in a CommandContext. If the key is a TranslatableText, this is the translation's id. Otherwise, this is the result of Text.toPlain().

Returns:

the raw key

parse

public void parse(CommandSource source,
                  CommandArgs args,
                  CommandContext context)
           throws ArgumentParseException

Attempt to extract a value for this element from the given arguments and put it in the given context. This method normally delegates to parseValue(CommandSource, CommandArgs) for getting the values. This method is expected to have no side-effects for the source, meaning that executing it will not change the state of the CommandSource in any way.

Parameters:

source - The source to parse for

args - The args to extract from

context - The context to supply to

Throws:

ArgumentParseException - if unable to extract a value

parseValue

@Nullable
protected abstract Object parseValue(CommandSource source,
                                               CommandArgs args)
                                        throws ArgumentParseException

Attempt to extract a value for this element from the given arguments. This method is expected to have no side-effects for the source, meaning that executing it will not change the state of the CommandSource in any way.

Parameters:

source - The source to parse for

args - the arguments

Returns:

The extracted value

Throws:

ArgumentParseException - if unable to extract a value

complete

public abstract List<String> complete(CommandSource src,
                                      CommandArgs args,
                                      CommandContext context)

Fetch completions for command arguments.

Parameters:

src - The source requesting tab completions

args - The arguments currently provided

context - The context to store state in

Returns:

Any relevant completions

getUsage

public Text getUsage(CommandSource src)

Return a usage message for this specific argument.

Parameters:

src - The source requesting usage

Returns:

The formatted usage