org.spongepowered.api.command.args

Class CommandFlags

java.lang.Object

org.spongepowered.api.command.args.CommandElement

org.spongepowered.api.command.args.CommandFlags

public final class CommandFlags
extends CommandElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandFlags.Builder
static class	CommandFlags.UnknownFlagBehavior Indicates to the flag parser how it should treat an argument that looks like a flag that it does not recognise.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandFlags(CommandElement childElement, Map<List<String>,CommandElement> usageFlags, Map<String,CommandElement> shortFlags, Map<String,CommandElement> longFlags, CommandFlags.UnknownFlagBehavior unknownShortFlagBehavior, CommandFlags.UnknownFlagBehavior unknownLongFlagBehavior, boolean anchorFlags)

Method Summary

Modifier and Type	Method and Description
List<String>	complete(CommandSource src, CommandArgs args, CommandContext context) Fetch completions for command arguments.
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 Object	parseValue(CommandSource source, CommandArgs args) Attempt to extract a value for this element from the given arguments.

Methods inherited from class org.spongepowered.api.command.args.CommandElement

getKey, getUntranslatedKey

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandFlags

protected CommandFlags(@Nullable
                       CommandElement childElement,
                       Map<List<String>,CommandElement> usageFlags,
                       Map<String,CommandElement> shortFlags,
                       Map<String,CommandElement> longFlags,
                       CommandFlags.UnknownFlagBehavior unknownShortFlagBehavior,
                       CommandFlags.UnknownFlagBehavior unknownLongFlagBehavior,
                       boolean anchorFlags)

Method Detail

parse

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

Description copied from class: CommandElement

Attempt to extract a value for this element from the given arguments and put it in the given context. This method normally delegates to CommandElement.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.

Overrides:

parse in class CommandElement

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

getUsage

public Text getUsage(CommandSource src)

Description copied from class: CommandElement

Return a usage message for this specific argument.

Overrides:

getUsage in class CommandElement

Parameters:

src - The source requesting usage

Returns:

The formatted usage

parseValue

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

Description copied from class: CommandElement

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.

Specified by:

parseValue in class CommandElement

Parameters:

source - The source to parse for

args - the arguments

Returns:

The extracted value

Throws:

ArgumentParseException - if unable to extract a value

complete

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

Description copied from class: CommandElement

Fetch completions for command arguments.

Specified by:

complete in class CommandElement

Parameters:

src - The source requesting tab completions

args - The arguments currently provided

context - The context to store state in

Returns:

Any relevant completions