Package studio.mevera.imperat.command.parameters

Interface FlagParameter<S extends Source>

All Superinterfaces:

CommandParameter<S>, DescriptionHolder, PermissionHolder

All Known Implementing Classes:

FlagCommandParameter

public interface FlagParameter<S extends Source>
extends CommandParameter<S>

Method Summary

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

Methods inherited from interface studio.mevera.imperat.command.parameters.CommandParameter

asAnnotated, asCommand, asFlagParameter, asNumeric, copyWithDifferentPosition, format, getDefaultValueSupplier, getSinglePermission, getSuggestionResolver, isAnnotated, isCommand, isGreedy, isGreedyString, isNumeric, isOptional, isRequired, name, parent, parent, position, position, setFormat, setSinglePermission, similarTo, type, valueType, wrappedType

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

describe, describe, description

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

addPermission, getPermissions, hasPermission

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 SuggestionResolver<S> inputSuggestionResolver()

Returns:

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

isFlag

default boolean isFlag()

Specified by:

isFlag in interface CommandParameter<S extends Source>

Returns:

checks whether this parameter is a flag

isSwitch

default boolean isSwitch()