Package studio.mevera.imperat.command.arguments

Interface FlagArgument<S extends CommandSource>

All Superinterfaces:

Argument<S>, DescriptionHolder, PermissionHolder

All Known Implementing Classes:

FlagArgumentImpl

public interface FlagArgument<S extends CommandSource>
extends Argument<S>

Method Summary

Modifier and Type	Method	Description
@NotNull FlagData<S>	flagData()
@Nullable SuggestionProvider<S>	inputSuggestionResolver()
default Type	inputValueType()
default boolean	isFlag()
default boolean	isSwitch()

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

addValidator, asAnnotatedArgument, asCommand, asFlagParameter, asNumeric, format, getDefaultValueSupplier, 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.permissions.PermissionHolder

getPermissionsData, getPrimaryPermission, setPermissionData

Method Details

flagData

@NotNull
@NotNull FlagData<S> flagData()

Returns:

The flag's data

inputValueType

default Type inputValueType()

Returns:

The valueType of input value

inputSuggestionResolver

@Nullable
@Nullable SuggestionProvider<S> inputSuggestionResolver()

Returns:

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

isFlag

default boolean isFlag()

Specified by:

isFlag in interface Argument<S extends CommandSource>

Returns:

checks whether this parameter is a flag

isSwitch

default boolean isSwitch()