Package studio.mevera.imperat.command.parameters

Class FlagCommandParameter<S extends Source>

java.lang.Object

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

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

All Implemented Interfaces:

DescriptionHolder, CommandParameter<S>, FlagParameter<S>, PermissionHolder

@Internal
public final class FlagCommandParameter<S extends Source>
extends InputParameter<S>
implements FlagParameter<S>

Field Summary

Fields inherited from class studio.mevera.imperat.command.parameters.InputParameter

description, format, greedy, index, name, optional, optionalValueSupplier, parentCommand, permission, suggestionResolver, type

Method Summary

Modifier and Type	Method	Description
CommandParameter<S>	copyWithDifferentPosition(int newPosition)	Creates a copy of this parameter with a different position.
@NotNull FlagData<S>	flagData()
String	format()	Formats the usage parameter, the default value is the name of the parameter
@NotNull OptionalValueSupplier	getDefaultValueSupplier()
@Nullable SuggestionResolver<S>	inputSuggestionResolver()

Methods inherited from class studio.mevera.imperat.command.parameters.InputParameter

addPermission, asCommand, asFlagParameter, describe, description, equals, getPermissions, getSinglePermission, getSuggestionResolver, hashCode, isFlag, isGreedy, isGreedyString, isOptional, name, parent, parent, position, position, setFormat, setSinglePermission, similarTo, toString, type, 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, asCommand, asFlagParameter, asNumeric, 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.parameters.FlagParameter

inputValueType, isFlag, isSwitch

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

addPermission, getPermissions, hasPermission

Method Details

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>

Overrides:

format in class InputParameter<S extends Source>

Returns:

the formatted parameter

See Also:

• CommandParameter.name()

flagData

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

Specified by:

flagData in interface FlagParameter<S extends Source>

Returns:

The flag's data

getDefaultValueSupplier

@NotNull
public @NotNull OptionalValueSupplier getDefaultValueSupplier()

Specified by:

getDefaultValueSupplier in interface CommandParameter<S extends Source>

Overrides:

getDefaultValueSupplier in class InputParameter<S extends Source>

Returns:

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

inputSuggestionResolver

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

Specified by:

inputSuggestionResolver in interface FlagParameter<S extends Source>

Returns:

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

copyWithDifferentPosition

public CommandParameter<S> copyWithDifferentPosition(int newPosition)

Creates a copy of this parameter with a different position. Useful for commands that have multiple syntaxes.

Specified by:

copyWithDifferentPosition in interface CommandParameter<S extends Source>

Parameters:

newPosition - the new position to set

Returns:

a copy of this parameter with the new position