Package revxrsal.commands.util.tokenize

Class QuotedStringTokenizer

java.lang.Object

revxrsal.commands.util.tokenize.QuotedStringTokenizer

All Implemented Interfaces:

ArgumentParser

public final class QuotedStringTokenizer
extends Object
implements ArgumentParser

Parser for converting a quoted string into a list of arguments.

Grammar is roughly (yeah, this is not really a proper grammar but it gives you an idea of what's happening:

 WHITESPACE = Character.isWhiteSpace(codePoint)
 CHAR := (all unicode)
 ESCAPE := '\' CHAR
 QUOTE = ' | "
 UNQUOTED_ARG := (CHAR | ESCAPE)+ WHITESPACE
 QUOTED_ARG := QUOTE (CHAR | ESCAPE)+ QUOTE
 ARGS := ((UNQUOTED_ARG | QUOTED_ARG) WHITESPACE+)+

Field Summary

Fields

Modifier and Type	Field	Description
static final QuotedStringTokenizer	INSTANCE

Fields inherited from interface revxrsal.commands.command.ArgumentParser

NO_QUOTES, QUOTES

Method Summary

Modifier and Type	Method	Description
ArgumentStack	parse(@NotNull String arguments)	Parses the string and returns an ArgumentStack for it.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final QuotedStringTokenizer INSTANCE

Method Details

parse

public ArgumentStack parse(@NotNull
 @NotNull String arguments)
                    throws ArgumentParseException

Description copied from interface: ArgumentParser

Parses the string and returns an ArgumentStack for it.

Specified by:

parse in interface ArgumentParser

Parameters:

arguments - String to parse. This string is guaranteed never to be null or empty.

Returns:

The argument stack. You should create this with ArgumentStack.empty() or other methods

Throws:

ArgumentParseException - An exception to throw in case of errors while parsing the string. It is optional to throw this.