revxrsal.commands.parameter

Class StringParameterType

java.lang.Object

revxrsal.commands.parameter.StringParameterType

All Implemented Interfaces:

BaseParameterType, ParameterType<CommandActor,java.lang.String>

public final class StringParameterType
extends java.lang.Object
implements ParameterType<CommandActor,java.lang.String>

A basic ParameterType for parsing String types

Nested Class Summary

Nested classes/interfaces inherited from interface revxrsal.commands.parameter.ParameterType

ParameterType.Factory<A extends CommandActor>

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull ParameterType<A,java.lang.String>	greedy()
boolean	isGreedy() Returns whether this parameter is greedy or not.
java.lang.String	parse(@NotNull MutableStringStream input, @NotNull ExecutionContext<CommandActor> context) Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.
@NotNull PrioritySpec	parsePriority() The priority for an argument of this type over other candidate arguments.
static <A extends CommandActor> @NotNull ParameterType<A,java.lang.String>	single()

Methods inherited from class java.lang.Object

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

Methods inherited from interface revxrsal.commands.parameter.ParameterType

defaultSuggestions

Method Detail

greedy

@NotNull
public static <A extends CommandActor> @NotNull ParameterType<A,java.lang.String> greedy()

single

@NotNull
public static <A extends CommandActor> @NotNull ParameterType<A,java.lang.String> single()

parse

public java.lang.String parse(@NotNull
                              @NotNull MutableStringStream input,
                              @NotNull
                              @NotNull ExecutionContext<CommandActor> context)

Description copied from interface: ParameterType

Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.

Note: Lamp makes no guarantees about the times it may invoke this method. It may be called repeatedly for execution, tab completion, finding execution candidates, etc.

As such, it's important to implement the parse method with the following in mind:

• Avoid expensive computations
• Avoid "expensive computations"
• Avoid sending the actor any feedback inside this method. Any feedback should only be sent using exceptions (see CommandErrorException)
• Avoid any side-effects in general. Ideally, this method should be pure.

Specified by:

parse in interface ParameterType<CommandActor,java.lang.String>

Parameters:

input - The input stream. This argument type is free to consume as much as it needs

context - The command execution context, as well as arguments that have been resolved

Returns:

The parsed object. This should never be null.

isGreedy

public boolean isGreedy()

Description copied from interface: ParameterType

Returns whether this parameter is greedy or not. Greedy parameters are treated slightly differently:

• They must come at the end of the command
• They can provide tab completes indefinitely

Specified by:

isGreedy in interface ParameterType<CommandActor,java.lang.String>

Returns:

if this parameter is greedy or not

parsePriority

@NotNull
public @NotNull PrioritySpec parsePriority()

Description copied from interface: ParameterType

The priority for an argument of this type over other candidate arguments.

An example of this, is when a command has the following signatures:

• /foo [integer]
• /foo [string]

Because an integer parameter can only accept a certain type of input (i.e. numbers), it will have higher priority over a string parameter, and as such, if the user inputs /foo 10, the integer will be tested first, before moving on to the string.

For more details on the priority API, see PrioritySpec

Specified by:

parsePriority in interface ParameterType<CommandActor,java.lang.String>

Returns:

the parse priority for this parameter

See Also:

PrioritySpec