Package com.xpdustry.distributor.api.command

Interface CommandHelp.Entry

All Superinterfaces:

CommandHelp

Enclosing interface:

CommandHelp

@Immutable
public static non-sealed interface CommandHelp.Entry
extends CommandHelp

Represents a specific command entry.

Nested Class Summary

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

CommandHelp.Empty, CommandHelp.Entry, CommandHelp.Suggestion

Method Summary

Modifier and Type	Method	Description
List<CommandElement.Argument>	getArguments()	Returns the arguments of the command.
DescriptionFacade	getDescription()	Returns the description of the command.
List<CommandElement.Flag>	getFlags()	Returns the flags of the command.
String	getSyntax()	Returns the syntax of the command.
DescriptionFacade	getVerboseDescription()	Returns the verbose description of the command.
static CommandHelp.Entry	of(String syntax, DescriptionFacade description, DescriptionFacade verboseDescription, List<CommandElement.Argument> arguments, List<CommandElement.Flag> flags)	Creates a new command entry.

Method Details

of

static CommandHelp.Entry of(String syntax,
 DescriptionFacade description,
 DescriptionFacade verboseDescription,
 List<CommandElement.Argument> arguments,
 List<CommandElement.Flag> flags)

Creates a new command entry.

Parameters:

syntax - the syntax of the command

description - the description of the command

verboseDescription - the verbose description of the command

arguments - the arguments of the command

flags - the flags of the command

getSyntax

String getSyntax()

Returns the syntax of the command.

getDescription

DescriptionFacade getDescription()

Returns the description of the command.

getVerboseDescription

DescriptionFacade getVerboseDescription()

Returns the verbose description of the command.

getArguments

List<CommandElement.Argument> getArguments()

Returns the arguments of the command.

getFlags

List<CommandElement.Flag> getFlags()

Returns the flags of the command.