org.spongepowered.api.command.args

Class SelectorCommandElement

java.lang.Object

org.spongepowered.api.command.args.CommandElement

org.spongepowered.api.command.args.PatternMatchingCommandElement

org.spongepowered.api.command.args.SelectorCommandElement

public abstract class SelectorCommandElement
extends PatternMatchingCommandElement

Abstract command element that matches values based on a Selector.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SelectorCommandElement(Text key)

Method Summary

Modifier and Type	Method and Description
List<String>	complete(CommandSource src, CommandArgs args, CommandContext context) Fetch completions for command arguments.
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.PatternMatchingCommandElement

getChoices, getExactMatch, getValue

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

getKey, getUntranslatedKey, getUsage, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectorCommandElement

protected SelectorCommandElement(@Nullable
                                 Text key)

Method Detail

parseValue

@Nullable
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.

Overrides:

parseValue in class PatternMatchingCommandElement

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.

Overrides:

complete in class PatternMatchingCommandElement

Parameters:

src - The source requesting tab completions

args - The arguments currently provided

context - The context to store state in

Returns:

Any relevant completions