org.spongepowered.api.command.args

Class PatternMatchingCommandElement

java.lang.Object

org.spongepowered.api.command.args.CommandElement

org.spongepowered.api.command.args.PatternMatchingCommandElement

Direct Known Subclasses:

SelectorCommandElement

public abstract class PatternMatchingCommandElement
extends CommandElement

Abstract command element that matches values based on pattern.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PatternMatchingCommandElement(Text key)
protected	PatternMatchingCommandElement(Text key, boolean yesIWantRegex)

Method Summary

Modifier and Type	Method and Description
List<String>	complete(CommandSource src, CommandArgs args, CommandContext context) Fetch completions for command arguments.
protected abstract Iterable<String>	getChoices(CommandSource source) Gets the available choices for this command source.
protected Optional<Object>	getExactMatch(Iterable<String> choices, String potentialChoice) Tests a string against a set of valid choices to see if it is a case-insensitive match.
protected abstract Object	getValue(String choice) Gets the value for a given choice.
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, getUsage, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternMatchingCommandElement

protected PatternMatchingCommandElement(@Nullable
                                        Text key,
                                        boolean yesIWantRegex)

Parameters:

yesIWantRegex - Specify if you want to allow regex for users of the command element. Note that this will open up for DoS attacks.

PatternMatchingCommandElement

protected PatternMatchingCommandElement(@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.

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

getExactMatch

protected Optional<Object> getExactMatch(Iterable<String> choices,
                                         String potentialChoice)

Tests a string against a set of valid choices to see if it is a case-insensitive match.

Parameters:

choices - The choices available to match against

potentialChoice - The potential choice

Returns:

If matched, an Optional containing the matched value

getChoices

protected abstract Iterable<String> getChoices(CommandSource source)

Gets the available choices for this command source.

Parameters:

source - The source requesting choices

Returns:

the possible choices

getValue

protected abstract Object getValue(String choice)
                            throws IllegalArgumentException

Gets the value for a given choice. For any result in getChoices(CommandSource), this must return a non-null value. Otherwise, an IllegalArgumentException may be throw.

Parameters:

choice - The specified choice

Returns:

the choice's value

Throws:

IllegalArgumentException - if the input string is not any return value of getChoices(CommandSource)