Package cloud.commandframework.arguments.parser

Class StandardParameters

java.lang.Object

cloud.commandframework.arguments.parser.StandardParameters

@API(status=STABLE)
public final class StandardParameters
extends Object

Common parser parameters used when resolving types in the ParserRegistry

Field Summary

Fields

Modifier and Type	Field	Description
static final ParserParameter<String[]>	COMPLETIONS	Command completions
static final ParserParameter<Boolean>	CONFIRMATION	Command confirmation
static final ParserParameter<String>	DESCRIPTION	Command description
static final ParserParameter<Boolean>	FLAG_YIELDING	Indicates that an argument should stop parsing when encountering a potential flag.
static final ParserParameter<Boolean>	GREEDY	Indicates that a string argument should be greedy
static final ParserParameter<Boolean>	HIDDEN	The command should be hidden from help menus, etc
static final ParserParameter<Boolean>	LIBERAL	Indicates that a boolean argument should be liberal.
static final ParserParameter<Boolean>	QUOTED	Indicates that a string argument should be quoted.
static final ParserParameter<Number>	RANGE_MAX	Maximum value accepted by a numerical parser
static final ParserParameter<Number>	RANGE_MIN	Minimum value accepted by a numerical parser

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

RANGE_MIN

public static final ParserParameter<Number> RANGE_MIN

Minimum value accepted by a numerical parser

RANGE_MAX

public static final ParserParameter<Number> RANGE_MAX

Maximum value accepted by a numerical parser

DESCRIPTION

public static final ParserParameter<String> DESCRIPTION

Command description

CONFIRMATION

public static final ParserParameter<Boolean> CONFIRMATION

Command confirmation

COMPLETIONS

public static final ParserParameter<String[]> COMPLETIONS

Command completions

HIDDEN

public static final ParserParameter<Boolean> HIDDEN

The command should be hidden from help menus, etc

GREEDY

public static final ParserParameter<Boolean> GREEDY

Indicates that a string argument should be greedy

FLAG_YIELDING

@API(status=STABLE,
     since="1.7.0")
public static final ParserParameter<Boolean> FLAG_YIELDING

Indicates that an argument should stop parsing when encountering a potential flag.

Since:

1.7.0

See Also:

• FlagYielding

QUOTED

@API(status=STABLE,
     since="1.5.0")
public static final ParserParameter<Boolean> QUOTED

Indicates that a string argument should be quoted.

Since:

1.5.0

LIBERAL

@API(status=STABLE,
     since="1.6.0")
public static final ParserParameter<Boolean> LIBERAL

Indicates that a boolean argument should be liberal.

Since:

1.6.0