Package studio.mevera.imperat.command.arguments

Class InputArgument<S extends CommandSource>

java.lang.Object

studio.mevera.imperat.command.arguments.InputArgument<S>

All Implemented Interfaces:

Argument<S>, DescriptionHolder, PermissionHolder

Direct Known Subclasses:

AnnotationArgumentDecorator, FlagArgumentImpl, NumericArgumentDecorator

@Internal
public abstract class InputArgument<S extends CommandSource>
extends Object
implements Argument<S>

Field Summary

Fields

Modifier and Type	Field	Description
protected final DefaultValueProvider	defaultValueProvider
protected Description	description
protected final boolean	flag
protected String	format
protected final boolean	greedy
protected int	index
protected final String	name
protected final boolean	optional
protected Command<S>	parentCommand
protected PermissionsData	permissionsData
protected final SuggestionProvider<S>	suggestionProvider
protected final ArgumentType<S,?>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputArgument(String name, @NotNull ArgumentType<S,?> type, @NotNull PermissionsData permissionsData, Description description, boolean optional, boolean flag, boolean greedy, @NotNull DefaultValueProvider defaultValueProvider, @Nullable SuggestionProvider<S> suggestionProvider)

Method Summary

Modifier and Type	Method	Description
void	addValidator(@NotNull ArgValidator<S> validator)
Command<S>	asCommand()	Casts the parameter to a subcommand/command
FlagArgument<S>	asFlagParameter()	Casts the parameter to a flag parameter
void	describe(Description description)	Sets the description for this entity.
boolean	equals(Object o)
String	format()	Formats the usage parameter, the default value is the name of the parameter
@NotNull DefaultValueProvider	getDefaultValueSupplier()
Description	getDescription()	Retrieves the current description associated with this entity.
String	getName()
@Nullable Command<S>	getParent()
@NotNull PermissionsData	getPermissionsData()
int	getPosition()
@Nullable SuggestionProvider<S>	getSuggestionResolver()	Fetches the suggestion resolver linked to this command parameter.
@NotNull PriorityList<ArgValidator<S>>	getValidators()
int	hashCode()
boolean	isFlag()
boolean	isGreedy()
boolean	isGreedyString()
boolean	isOptional()
final void	setFormat(String format)	Sets a custom format for this parameter the default value is the name of the parameter
void	setParent(@NotNull Command<S> parentCommand)	Sets parent command for a parameter
void	setPermissionData(@NotNull PermissionsData permission)
void	setPosition(int position)	Sets the position of this parameter in a syntax DO NOT USE THIS FOR ANY REASON unless it's necessary to do so
boolean	similarTo(Argument<?> parameter)	Checks if this parameter has same name and valueType to the other Argument unlike `Argument#equals(Object)`, if both parameters are only different in their parent Command, it would still return true
String	toString()
@NotNull ArgumentType<S,?>	type()	Retrieves the parameter type associated with this command parameter.
void	validate(ExecutionContext<S> context, ParsedArgument<S> parsedArgument)
TypeWrap<?>	wrappedType()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface studio.mevera.imperat.command.arguments.Argument

asAnnotatedArgument, asNumeric, greedyLimit, isAnnotated, isCommand, isNumeric, isRequired, valueType

Methods inherited from interface studio.mevera.imperat.command.DescriptionHolder

describe

Methods inherited from interface studio.mevera.imperat.permissions.PermissionHolder

getPrimaryPermission

Field Details

name

protected final String name

type

protected final ArgumentType<S extends CommandSource,?> type

optional

protected final boolean optional

flag

protected final boolean flag

greedy

protected final boolean greedy

defaultValueProvider

protected final DefaultValueProvider defaultValueProvider

suggestionProvider

protected final SuggestionProvider<S extends CommandSource> suggestionProvider

parentCommand

protected Command<S extends CommandSource> parentCommand

format

protected String format

permissionsData

protected PermissionsData permissionsData

description

protected Description description

index

protected int index

Constructor Details

InputArgument

protected InputArgument(String name,
 @NotNull
 @NotNull ArgumentType<S,?> type,
 @NotNull
 @NotNull PermissionsData permissionsData,
 Description description,
 boolean optional,
 boolean flag,
 boolean greedy,
 @NotNull
 @NotNull DefaultValueProvider defaultValueProvider,
 @Nullable
 @Nullable SuggestionProvider<S> suggestionProvider)

Method Details

getName

public String getName()

Specified by:

getName in interface Argument<S extends CommandSource>

Returns:

the name of the parameter

format

public String format()

Description copied from interface: Argument

Formats the usage parameter, the default value is the name of the parameter

Specified by:

format in interface Argument<S extends CommandSource>

Returns:

the formatted parameter

See Also:

• Argument.getName()

setFormat

public final void setFormat(String format)

Description copied from interface: Argument

Sets a custom format for this parameter the default value is the name of the parameter

Specified by:

setFormat in interface Argument<S extends CommandSource>

Parameters:

format - the format to set

See Also:

• Argument.getName()

getParent

@Nullable
public @Nullable Command<S> getParent()

Specified by:

getParent in interface Argument<S extends CommandSource>

Returns:

the parent of this parameter

setParent

public void setParent(@NotNull
 @NotNull Command<S> parentCommand)

Description copied from interface: Argument

Sets parent command for a parameter

Specified by:

setParent in interface Argument<S extends CommandSource>

Parameters:

parentCommand - the parameter's owning command

getPosition

public int getPosition()

Specified by:

getPosition in interface Argument<S extends CommandSource>

Returns:

the index of this parameter

setPosition

public void setPosition(int position)

Sets the position of this parameter in a syntax DO NOT USE THIS FOR ANY REASON unless it's necessary to do so

Specified by:

setPosition in interface Argument<S extends CommandSource>

Parameters:

position - the position to set

type

@NotNull
public @NotNull ArgumentType<S,?> type()

Description copied from interface: Argument

Retrieves the parameter type associated with this command parameter.

Specified by:

type in interface Argument<S extends CommandSource>

Returns:

the ArgumentType of the command parameter

wrappedType

public TypeWrap<?> wrappedType()

Specified by:

wrappedType in interface Argument<S extends CommandSource>

Returns:

the value valueType-token of this parameter

getPermissionsData

@NotNull
public @NotNull PermissionsData getPermissionsData()

Specified by:

getPermissionsData in interface PermissionHolder

setPermissionData

public void setPermissionData(@NotNull
 @NotNull PermissionsData permission)

Specified by:

setPermissionData in interface PermissionHolder

getDefaultValueSupplier

@NotNull
public @NotNull DefaultValueProvider getDefaultValueSupplier()

Specified by:

getDefaultValueSupplier in interface Argument<S extends CommandSource>

Returns:

the default value if it's input is not present in case of the parameter being optional

isOptional

public boolean isOptional()

Specified by:

isOptional in interface Argument<S extends CommandSource>

Returns:

whether this is an optional argument

isFlag

public boolean isFlag()

Specified by:

isFlag in interface Argument<S extends CommandSource>

Returns:

checks whether this parameter is a flag

asFlagParameter

public FlagArgument<S> asFlagParameter()

Casts the parameter to a flag parameter

Specified by:

asFlagParameter in interface Argument<S extends CommandSource>

Returns:

the parameter as a flag

isGreedy

public boolean isGreedy()

Specified by:

isGreedy in interface Argument<S extends CommandSource>

Returns:

checks whether this parameter consumes all the args input after it.

isGreedyString

public boolean isGreedyString()

Specified by:

isGreedyString in interface Argument<S extends CommandSource>

asCommand

public Command<S> asCommand()

Description copied from interface: Argument

Casts the parameter to a subcommand/command

Specified by:

asCommand in interface Argument<S extends CommandSource>

Returns:

the parameter as a command

getSuggestionResolver

@Nullable
public @Nullable SuggestionProvider<S> getSuggestionResolver()

Fetches the suggestion resolver linked to this command parameter.

Specified by:

getSuggestionResolver in interface Argument<S extends CommandSource>

Returns:

the SuggestionProvider for a resolving suggestion

getDescription

public Description getDescription()

Description copied from interface: DescriptionHolder

Retrieves the current description associated with this entity.

Specified by:

getDescription in interface DescriptionHolder

Returns:

the current Description.

describe

public void describe(Description description)

Description copied from interface: DescriptionHolder

Sets the description for this entity.

Specified by:

describe in interface DescriptionHolder

Parameters:

description - the Description to set.

addValidator

public void addValidator(@NotNull
 @NotNull ArgValidator<S> validator)

Specified by:

addValidator in interface Argument<S extends CommandSource>

getValidators

@NotNull
public @NotNull PriorityList<ArgValidator<S>> getValidators()

Specified by:

getValidators in interface Argument<S extends CommandSource>

validate

public void validate(ExecutionContext<S> context,
 ParsedArgument<S> parsedArgument)
              throws CommandException

Specified by:

validate in interface Argument<S extends CommandSource>

Throws:

CommandException

similarTo

public boolean similarTo(Argument<?> parameter)

Description copied from interface: Argument

Checks if this parameter has same name and valueType to the other Argument unlike `Argument#equals(Object)`, if both parameters are only different in their parent Command, it would still return true

Specified by:

similarTo in interface Argument<S extends CommandSource>

Parameters:

parameter - the parameter to compare to

Returns:

Whether this parameter has same name and valueType to the other Argument or not

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object