Package studio.mevera.imperat.command.arguments

Class FlagArgumentImpl<S extends CommandSource>

java.lang.Object

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

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

All Implemented Interfaces:

Argument<S>, FlagArgument<S>, DescriptionHolder, PermissionHolder

@Internal
public final class FlagArgumentImpl<S extends CommandSource>
extends InputArgument<S>
implements FlagArgument<S>

Field Summary

Fields inherited from class studio.mevera.imperat.command.arguments.InputArgument

defaultValueProvider, description, format, greedy, index, name, optional, parentCommand, permissionsData, suggestionProvider, type

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NotNull FlagData<S>	flagData()
String	format()	Formats the usage parameter, the default value is the name of the parameter
@NotNull DefaultValueProvider	getDefaultValueSupplier()
int	hashCode()
@Nullable SuggestionProvider<S>	inputSuggestionResolver()

Methods inherited from class studio.mevera.imperat.command.arguments.InputArgument

addValidator, asCommand, asFlagParameter, describe, getDescription, getName, getParent, getPermissionsData, getPosition, getSuggestionResolver, getValidators, isFlag, isGreedy, isGreedyString, isOptional, setFormat, setParent, setPermissionData, setPosition, similarTo, toString, type, validate, 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

addValidator, asAnnotatedArgument, asCommand, asFlagParameter, asNumeric, getName, getParent, getPosition, getSuggestionResolver, getValidators, greedyLimit, isAnnotated, isCommand, isGreedy, isGreedyString, isNumeric, isOptional, isRequired, setFormat, setParent, setPosition, similarTo, type, validate, valueType, wrappedType

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

describe, describe, getDescription

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

inputValueType, isFlag, isSwitch

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

getPermissionsData, getPrimaryPermission, setPermissionData

Method Details

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>

Overrides:

format in class InputArgument<S extends CommandSource>

Returns:

the formatted parameter

See Also:

• Argument.getName()

flagData

@NotNull
public @NotNull FlagData<S> flagData()

Specified by:

flagData in interface FlagArgument<S extends CommandSource>

Returns:

The flag's data

getDefaultValueSupplier

@NotNull
public @NotNull DefaultValueProvider getDefaultValueSupplier()

Specified by:

getDefaultValueSupplier in interface Argument<S extends CommandSource>

Overrides:

getDefaultValueSupplier in class InputArgument<S extends CommandSource>

Returns:

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

inputSuggestionResolver

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

Specified by:

inputSuggestionResolver in interface FlagArgument<S extends CommandSource>

Returns:

the SuggestionProvider for input value of this flag null if the flag is switch, check using FlagArgument.isSwitch()

equals

public boolean equals(Object o)

Overrides:

equals in class InputArgument<S extends CommandSource>

hashCode

public int hashCode()

Overrides:

hashCode in class InputArgument<S extends CommandSource>