org.spongepowered.api.command.args.parsing

Interface InputTokenizer

public interface InputTokenizer

Method Summary

Modifier and Type	Method and Description
static InputTokenizer	quotedStrings(boolean forceLenient) Use an input string tokenizer that supports quoted arguments and character escapes.
static InputTokenizer	rawInput() Returns an input tokenizer that returns the input string as a single argument.
static InputTokenizer	spaceSplitString() Returns an input tokenizer that takes input strings and splits them by space.
List<SingleArg>	tokenize(String arguments, boolean lenient) Take the input string and split it as appropriate into argument tokens.

Method Detail

quotedStrings

static InputTokenizer quotedStrings(boolean forceLenient)

Use an input string tokenizer that supports quoted arguments and character escapes.

Forcing lenient to true makes the following apply:

• Unclosed quotations are treated as a single string from the opening quotation to the end of the arguments rather than throwing an exception

Parameters:

forceLenient - Whether the tokenizer is forced into lenient mode

Returns:

the appropriate tokenizer

spaceSplitString

static InputTokenizer spaceSplitString()

Returns an input tokenizer that takes input strings and splits them by space.

Returns:

The appropriate tokenizer

rawInput

static InputTokenizer rawInput()

Returns an input tokenizer that returns the input string as a single argument.

Returns:

The appropriate tokenizer

tokenize

List<SingleArg> tokenize(String arguments,
                         boolean lenient)
                  throws ArgumentParseException

Take the input string and split it as appropriate into argument tokens.

Parameters:

arguments - The provided arguments

lenient - Whether to parse leniently

Returns:

The tokenized strings. Empty list if error occurs

Throws:

ArgumentParseException - if an invalid input is provided