Package studio.mevera.imperat.command.parameters

Class InputParameter<S extends Source>

java.lang.Object

studio.mevera.imperat.command.parameters.InputParameter<S>

All Implemented Interfaces:

DescriptionHolder, CommandParameter<S>, PermissionHolder

Direct Known Subclasses:

AnnotationParameterDecorator, FlagCommandParameter, NumericParameterDecorator

@Internal
public abstract class InputParameter<S extends Source>
extends Object
implements CommandParameter<S>

Field Summary

Fields

Modifier and Type	Field	Description
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 final OptionalValueSupplier	optionalValueSupplier
protected Command<S>	parentCommand
protected String	permission
protected final SuggestionResolver<S>	suggestionResolver
protected final ParameterType<S,?>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InputParameter(String name, @NotNull ParameterType<S,?> type, @Nullable String permission, Description description, boolean optional, boolean flag, boolean greedy, @NotNull OptionalValueSupplier optionalValueSupplier, @Nullable SuggestionResolver<S> suggestionResolver)

Method Summary

Modifier and Type	Method	Description
void	addPermission(String permission)	Adds a permission for this holder.
Command<S>	asCommand()	Casts the parameter to a subcommand/command
FlagParameter<S>	asFlagParameter()	Casts the parameter to a flag parameter
void	describe(Description description)	Sets the description for this entity.
Description	description()	Retrieves the current description associated with this entity.
boolean	equals(Object o)
String	format()	Formats the usage parameter, the default value is the name of the parameter
@NotNull OptionalValueSupplier	getDefaultValueSupplier()
@Unmodifiable Set<String>	getPermissions()	The permission for this parameter
@Nullable String	getSinglePermission()	For parameters, ONLY one permission is allowed for each parameter.
@Nullable SuggestionResolver<S>	getSuggestionResolver()	Fetches the suggestion resolver linked to this command parameter.
int	hashCode()
boolean	isFlag()
boolean	isGreedy()
boolean	isGreedyString()
boolean	isOptional()
String	name()
@Nullable Command<S>	parent()
void	parent(@NotNull Command<S> parentCommand)	Sets parent command for a parameter
int	position()
void	position(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
final void	setFormat(String format)	Sets a custom format for this parameter the default value is the name of the parameter
void	setSinglePermission(String permission)
boolean	similarTo(CommandParameter<?> parameter)	Checks if this parameter has same name and valueType to the other CommandParameter unlike `CommandParameter#equals(Object)`, if both parameters are only different in their parent Command, it would still return true
String	toString()
@NotNull ParameterType<S,?>	type()	Retrieves the parameter type associated with this command parameter.
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.parameters.CommandParameter

asAnnotated, asNumeric, copyWithDifferentPosition, isAnnotated, isCommand, isNumeric, isRequired, valueType

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

describe

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

hasPermission

Field Details

parentCommand

protected Command<S extends Source> parentCommand

name

protected final String name

format

protected String format

type

protected final ParameterType<S extends Source,?> type

optional

protected final boolean optional

flag

protected final boolean flag

greedy

protected final boolean greedy

optionalValueSupplier

protected final OptionalValueSupplier optionalValueSupplier

suggestionResolver

protected final SuggestionResolver<S extends Source> suggestionResolver

permission

protected String permission

description

protected Description description

index

protected int index

Constructor Details

InputParameter

protected InputParameter(String name,
 @NotNull
 @NotNull ParameterType<S,?> type,
 @Nullable
 @Nullable String permission,
 Description description,
 boolean optional,
 boolean flag,
 boolean greedy,
 @NotNull
 @NotNull OptionalValueSupplier optionalValueSupplier,
 @Nullable
 @Nullable SuggestionResolver<S> suggestionResolver)

Method Details

name

public String name()

Specified by:

name in interface CommandParameter<S extends Source>

Returns:

the name of the parameter

format

public String format()

Description copied from interface: CommandParameter

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

Specified by:

format in interface CommandParameter<S extends Source>

Returns:

the formatted parameter

See Also:

• CommandParameter.name()

setFormat

public final void setFormat(String format)

Description copied from interface: CommandParameter

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

Specified by:

setFormat in interface CommandParameter<S extends Source>

Parameters:

format - the format to set

See Also:

• CommandParameter.name()

parent

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

Specified by:

parent in interface CommandParameter<S extends Source>

Returns:

the parent of this parameter

parent

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

Description copied from interface: CommandParameter

Sets parent command for a parameter

Specified by:

parent in interface CommandParameter<S extends Source>

Parameters:

parentCommand - the parameter's owning command

position

public int position()

Specified by:

position in interface CommandParameter<S extends Source>

Returns:

the index of this parameter

position

public void position(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:

position in interface CommandParameter<S extends Source>

Parameters:

position - the position to set

type

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

Description copied from interface: CommandParameter

Retrieves the parameter type associated with this command parameter.

Specified by:

type in interface CommandParameter<S extends Source>

Returns:

the ParameterType of the command parameter

wrappedType

public TypeWrap<?> wrappedType()

Specified by:

wrappedType in interface CommandParameter<S extends Source>

Returns:

the value valueType-token of this parameter

getSinglePermission

@Nullable
public @Nullable String getSinglePermission()

Description copied from interface: CommandParameter

For parameters, ONLY one permission is allowed for each parameter.

Specified by:

getSinglePermission in interface CommandParameter<S extends Source>

Returns:

the single permission for this parameter.

setSinglePermission

public void setSinglePermission(String permission)

Specified by:

setSinglePermission in interface CommandParameter<S extends Source>

getPermissions

public @Unmodifiable Set<String> getPermissions()

The permission for this parameter

Specified by:

getPermissions in interface PermissionHolder

Returns:

the parameter permission

addPermission

public void addPermission(String permission)

Description copied from interface: PermissionHolder

Adds a permission for this holder.

Specified by:

addPermission in interface PermissionHolder

Parameters:

permission - the permission string to add, can be null.

getDefaultValueSupplier

@NotNull
public @NotNull OptionalValueSupplier getDefaultValueSupplier()

Specified by:

getDefaultValueSupplier in interface CommandParameter<S extends Source>

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 CommandParameter<S extends Source>

Returns:

whether this is an optional argument

isFlag

public boolean isFlag()

Specified by:

isFlag in interface CommandParameter<S extends Source>

Returns:

checks whether this parameter is a flag

asFlagParameter

public FlagParameter<S> asFlagParameter()

Casts the parameter to a flag parameter

Specified by:

asFlagParameter in interface CommandParameter<S extends Source>

Returns:

the parameter as a flag

isGreedy

public boolean isGreedy()

Specified by:

isGreedy in interface CommandParameter<S extends Source>

Returns:

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

isGreedyString

public boolean isGreedyString()

Specified by:

isGreedyString in interface CommandParameter<S extends Source>

asCommand

public Command<S> asCommand()

Description copied from interface: CommandParameter

Casts the parameter to a subcommand/command

Specified by:

asCommand in interface CommandParameter<S extends Source>

Returns:

the parameter as a command

getSuggestionResolver

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

Fetches the suggestion resolver linked to this command parameter.

Specified by:

getSuggestionResolver in interface CommandParameter<S extends Source>

Returns:

the SuggestionResolver for a resolving suggestion

description

public Description description()

Description copied from interface: DescriptionHolder

Retrieves the current description associated with this entity.

Specified by:

description 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.

similarTo

public boolean similarTo(CommandParameter<?> parameter)

Description copied from interface: CommandParameter

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

Specified by:

similarTo in interface CommandParameter<S extends Source>

Parameters:

parameter - the parameter to compare to

Returns:

Whether this parameter has same name and valueType to the other CommandParameter 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