Package io.github.mqzn.commands.arguments

Class AbstractArgument<T>

java.lang.Object

io.github.mqzn.commands.arguments.AbstractArgument<T>

All Implemented Interfaces:

Argument<T>

Direct Known Subclasses:

ArgumentBoolean, ArgumentEnum, ArgumentLiteral, ArgumentNumber, ArgumentStringArray, ArgumentWord

public abstract class AbstractArgument<T>
extends Object
implements Argument<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull List<T>	suggestions

Constructor Summary

Constructors

Constructor	Description
AbstractArgument(@NotNull ArgumentData data, Class<T> type)
AbstractArgument(@NotNull String id, @NotNull Class<T> type)
AbstractArgument(@NotNull String id, @NotNull Class<T> type, boolean optional, boolean useRemainingSpace)
AbstractArgument(String id, Class<T> type, boolean useRemainingSpace)

Method Summary

Modifier and Type	Method	Description
Argument<T>	asOptional()
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 !
String	id()	The id of the Required argument
boolean	isOptional()
@NotNull Argument<T>	setDefaultValue(T value)	Modifies the default value of the argument
void	setOptional(boolean optional)
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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mqzn.commands.arguments.Argument

alternativeTypes, isSuggestionDynamic, parse, suggest

Field Details

suggestions

@NotNull
protected final @NotNull List<T> suggestions

Constructor Details

AbstractArgument

public AbstractArgument(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull Class<T> type)

AbstractArgument

public AbstractArgument(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull Class<T> type,
 boolean optional,
 boolean useRemainingSpace)

AbstractArgument

public AbstractArgument(String id,
 Class<T> type,
 boolean useRemainingSpace)

AbstractArgument

public AbstractArgument(@NotNull
 @NotNull ArgumentData data,
 Class<T> type)

Method Details

id

public String id()

The id of the Required argument

Specified by:

id in interface Argument<T>

Returns:

the id of the Required argument

type

public Class<T> type()

The type of the argument

Specified by:

type in interface Argument<T>

Returns:

the class type of the argument

defaultValue

@Nullable
public T defaultValue()

Description copied from interface: Argument

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

Specified by:

defaultValue in interface Argument<T>

Returns:

The default value of this argument

setDefaultValue

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

Description copied from interface: Argument

Modifies the default value of the argument

Specified by:

setDefaultValue in interface Argument<T>

Parameters:

value - the new default value

isOptional

public boolean isOptional()

Specified by:

isOptional in interface Argument<T>

setOptional

public void setOptional(boolean optional)

Specified by:

setOptional in interface Argument<T>

asOptional

public Argument<T> asOptional()

useRemainingSpace

public boolean useRemainingSpace()

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

Specified by:

useRemainingSpace in interface Argument<T>

Returns:

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

suggest

public Argument<T> suggest(@NotNull
 T suggestion)

Specified by:

suggest in interface Argument<T>

suggestions

@NotNull
public @NotNull List<T> suggestions()

Specified by:

suggestions in interface Argument<T>

toString

public String toString(T obj)

Specified by:

toString in interface Argument<T>