net.lenni0451.commandlib.types

Class StringType<E>

java.lang.Object

net.lenni0451.commandlib.types.StringType<E>

Type Parameters:

E - The type of the executor

All Implemented Interfaces:

ArgumentType<E,java.lang.String>

public class StringType<E>
extends java.lang.Object
implements ArgumentType<E,java.lang.String>

The string type parses a string from the string reader.
There are three different types of strings:
- Type#WORD - A single word
- Type#STRING - A single word or a string surrounded by single or double quotes
- Type#GREEDY_STRING - A string that contains all remaining characters

Method Summary

Modifier and Type	Method and Description
int	getWeight()
static <E> StringType<E>	greedyString() Create a new string type that parses a string that contains all remaining characters.
void	parseCompletions(java.util.Set<java.lang.String> completions, ExecutionContext<E> executionContext, StringReader stringReader) Provide the completions of this argument.
java.lang.String	parseValue(ExecutionContext<E> executionContext, StringReader stringReader) Parses the value of the argument.
static <E> StringType<E>	string() Create a new string type that parses a single word or a string surrounded by single or double quotes.
static <E> StringType<E>	word() Create a new string type that parses a single word.

Methods inherited from class java.lang.Object

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

Method Detail

word

public static <E> StringType<E> word()

Create a new string type that parses a single word.

Type Parameters:

E - The type of the executor

Returns:

The new string type

string

public static <E> StringType<E> string()

Create a new string type that parses a single word or a string surrounded by single or double quotes.

Type Parameters:

E - The type of the executor

Returns:

The new string type

greedyString

public static <E> StringType<E> greedyString()

Create a new string type that parses a string that contains all remaining characters.

Type Parameters:

E - The type of the executor

Returns:

The new string type

getWeight

public int getWeight()

Specified by:

getWeight in interface ArgumentType<E,java.lang.String>

Returns:

The weight of this type. The higher the weight the more important it is.

parseValue

@Nonnull
public java.lang.String parseValue(ExecutionContext<E> executionContext,
                                             StringReader stringReader)
                                      throws ArgumentParseException,
                                             java.lang.RuntimeException

Description copied from interface: ArgumentType

Parses the value of the argument.

Specified by:

parseValue in interface ArgumentType<E,java.lang.String>

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

parseCompletions

public void parseCompletions(java.util.Set<java.lang.String> completions,
                             ExecutionContext<E> executionContext,
                             StringReader stringReader)

Description copied from interface: ArgumentType

Provide the completions of this argument.

Specified by:

parseCompletions in interface ArgumentType<E,java.lang.String>

Parameters:

completions - The set of completions

executionContext - The execution context

stringReader - The string reader