com.sk89q.intake

Interface Description

All Known Implementing Classes:

ImmutableDescription

public interface Description

A description of a command, providing information on the command's parameters, a short description, a help text, and usage information. However, it is up for implementations to provide the information — some implementations may provide very little information.

This class does not define a way to execute the command. See CommandCallable, which has a getDescription() method, for an interface that does define how a command is executed.

Method Summary

Modifier and Type	Method and Description
String	getHelp() Get a longer help text about this command.
List<Parameter>	getParameters() Get the list of parameters for this command.
List<String>	getPermissions() Get a list of permissions that the player may have to have permission.
String	getShortDescription() Get a short one-line description of this command.
String	getUsage() Get the usage string of this command.

Method Detail

getParameters

List<Parameter> getParameters()

Get the list of parameters for this command.

Returns:

A list of parameters

getShortDescription

@Nullable
String getShortDescription()

Get a short one-line description of this command.

Returns:

A description, or null if no description is available

getHelp

@Nullable
String getHelp()

Get a longer help text about this command.

Returns:

A help text, or null if no help is available

getUsage

String getUsage()

Get the usage string of this command.

A usage string may look like [-w <world>] <var1> <var2>.

Returns:

A usage string

getPermissions

List<String> getPermissions()

Get a list of permissions that the player may have to have permission.

Permission data may or may not be available. This is only useful as a potential hint.

Returns:

The list of permissions