Package com.xpdustry.distributor.api.command

Interface CommandElement.Flag

All Superinterfaces:

CommandElement

Enclosing interface:

CommandElement

@Immutable
public static sealed interface CommandElement.Flag
extends CommandElement

Represents a command flag, usually an optional named argument.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CommandElement.Flag.Kind	Determines how a flag is parsed on a high level.
static enum	CommandElement.Flag.Mode	Determines how many times a flag can be used.

Nested classes/interfaces inherited from interface com.xpdustry.distributor.api.command.CommandElement

CommandElement.Argument, CommandElement.Flag

Method Summary

Modifier and Type	Method	Description
CommandElement.Flag.Kind	getKind()	Returns the kind of this flag.
CommandElement.Flag.Mode	getMode()	Returns the mode of this flag.
static CommandElement.Flag	of(String name, DescriptionFacade description, Set<String> aliases, CommandElement.Flag.Kind kind, CommandElement.Flag.Mode mode)	Creates a new command flag.

Methods inherited from interface com.xpdustry.distributor.api.command.CommandElement

getAliases, getDescription, getName

Method Details

of

static CommandElement.Flag of(String name,
 DescriptionFacade description,
 Set<String> aliases,
 CommandElement.Flag.Kind kind,
 CommandElement.Flag.Mode mode)

Creates a new command flag.

Parameters:

name - the name of the flag

description - the description of the flag

aliases - the aliases of the flag

kind - the kind of the flag

mode - the mode of the flag

Returns:

the created flag

getKind

CommandElement.Flag.Kind getKind()

Returns the kind of this flag.

getMode

CommandElement.Flag.Mode getMode()

Returns the mode of this flag.