Package io.github.mqzn.commands.arguments

Interface Argument<T>

Type Parameters:

T - the data type of the argument parameter

All Known Implementing Classes:

AbstractArgument, ArgumentBoolean, ArgumentDouble, ArgumentEnum, ArgumentFloat, ArgumentInteger, ArgumentLiteral, ArgumentLong, ArgumentNumber, ArgumentStringArray, ArgumentWord

public interface Argument<T>

An interface to represent an argument as a command-syntax parameter to be used in usages and context parsing

Method Summary

Modifier and Type	Method	Description
default Class<?>[]	alternativeTypes()
static ArgumentStringArray	Array(String id)
static ArgumentBoolean	Boolean(@NotNull ArgumentData data)
static ArgumentBoolean	Boolean(String id)
T	defaultValue()	The default value of this argument if the default value is null, means it has no default values, so it's a REQUIRED argument !
Optional<@Nullable String>	description()	The description of an argument
Argument<T>	description(@Nullable String description)
static ArgumentDouble	Double(@NotNull ArgumentData data)
static ArgumentDouble	Double(String id)
static <E extends Enum<E>> ArgumentEnum<E>	Enum(ArgumentData data, Class<E> enumClass)
static <E extends Enum<E>> ArgumentEnum<E>	Enum(String id, Class<E> enumClass)
static ArgumentFloat	Float(@NotNull ArgumentData data)
static ArgumentFloat	Float(String id)
String	id()	The id of the Required argument
static ArgumentInteger	integer(@NotNull ArgumentData data)
static ArgumentInteger	integer(String id)
default boolean	isOptional()
default boolean	isSuggestionDynamic()
static ArgumentLiteral	literal(@NotNull ArgumentData data)
static ArgumentLiteral	literal(String id)
static ArgumentLong	Long(ArgumentData id)
static ArgumentLong	Long(String id)
T	parse(@NotNull String command, @NotNull String input)
@NotNull Argument<T>	setDefaultValue(T value)	Modifies the default value of the argument
void	setOptional(boolean optional)
Argument<T>	suggest(@NotNull T... suggestions)
Argument<T>	suggest(T suggestion)
@NotNull List<T>	suggestions()
String	toString(T obj)
Class<T>	type()	The type of the argument
boolean	useRemainingSpace()	Whether the argument can become greedy and use the remaining args till the end of the args
static ArgumentWord	word(@NotNull ArgumentData data)
static ArgumentWord	word(String id)

Method Details

literal

static ArgumentLiteral literal(String id)

word

static ArgumentWord word(String id)

Boolean

static ArgumentBoolean Boolean(String id)

integer

static ArgumentInteger integer(String id)

Double

static ArgumentDouble Double(String id)

Float

static ArgumentFloat Float(String id)

Long

static ArgumentLong Long(String id)

Array

static ArgumentStringArray Array(String id)

Enum

static <E extends Enum<E>> ArgumentEnum<E> Enum(String id,
 Class<E> enumClass)

literal

static ArgumentLiteral literal(@NotNull
 @NotNull ArgumentData data)

word

static ArgumentWord word(@NotNull
 @NotNull ArgumentData data)

Boolean

static ArgumentBoolean Boolean(@NotNull
 @NotNull ArgumentData data)

integer

static ArgumentInteger integer(@NotNull
 @NotNull ArgumentData data)

Double

static ArgumentDouble Double(@NotNull
 @NotNull ArgumentData data)

Float

static ArgumentFloat Float(@NotNull
 @NotNull ArgumentData data)

Long

static ArgumentLong Long(ArgumentData id)

Enum

static <E extends Enum<E>> ArgumentEnum<E> Enum(ArgumentData data,
 Class<E> enumClass)

id

String id()

The id of the Required argument

Returns:

the id of the Required argument

description

Optional<@Nullable String> description()

The description of an argument

Returns:

the description for usage

type

Class<T> type()

The type of the argument

Returns:

the class type of the argument

useRemainingSpace

boolean useRemainingSpace()

Whether the argument can become greedy and use the remaining args till the end of the args

Returns:

Whether the argument can become greedy * and use the remaining args till the end of the args

defaultValue

@Nullable
T defaultValue()

The default value of this argument if the default value is null, means it has no default values, so it's a REQUIRED argument !

Returns:

The default value of this argument

setDefaultValue

@NotNull
@NotNull Argument<T> setDefaultValue(T value)

Modifies the default value of the argument

Parameters:

value - the new default value

parse

T parse(@NotNull
 @NotNull String command,
 @NotNull
 @NotNull String input)
 throws ArgumentParseException

Throws:

ArgumentParseException

isOptional

default boolean isOptional()

setOptional

void setOptional(boolean optional)

suggest

Argument<T> suggest(@NotNull
 T suggestion)

description

Argument<T> description(@Nullable
 @Nullable String description)

suggestions

@NotNull
@NotNull List<T> suggestions()

suggest

Argument<T> suggest(@NotNull
 @NotNull T... suggestions)

toString

String toString(T obj)

alternativeTypes

default Class<?>[] alternativeTypes()

isSuggestionDynamic

default boolean isSuggestionDynamic()