com.sk89q.intake

Annotation Type Command

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Command

Annotates a method that is to be registered as a command.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	aliases A list of aliases for the command.
String	desc A short description of the command.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	anyFlags Get whether any flag can be used.
String	flags Flags allow special processing for flags such as -h in the command, allowing users to easily turn on a flag.
String	help A long description for the command.
int	max The maximum number of arguments.
int	min The minimum number of arguments.
String	usage An example usage string of the command.

Element Detail

aliases

public abstract String[] aliases

A list of aliases for the command. The first alias is the name of the command and considered the main alias.

Returns:

Aliases for a command

desc

public abstract String desc

A short description of the command.

Returns:

A short description for the command.

usage

public abstract String usage

An example usage string of the command.

An example would be [-h <value>] <name> <message>.

If a parametric command is used, this field is unnecessary because usage information will be generated automatically.

Returns:

Usage instructions for a command

Default:

""

min

public abstract int min

The minimum number of arguments. This should be 0 or above.

Returns:

The minimum number of arguments

Default:

0

max

public abstract int max

The maximum number of arguments. Use -1 for an unlimited number of arguments.

Returns:

The maximum number of arguments

Default:

-1

flags

public abstract String flags

Flags allow special processing for flags such as -h in the command, allowing users to easily turn on a flag. This is a string with each character being a flag. Use A-Z and a-z as possible flags. Appending a flag with a : makes the flag character before a value flag, meaning that if it is given, it must have a value.

Returns:

Flags matching a-zA-Z

See Also:

to see accept any flag

Default:

""

help

public abstract String help

A long description for the command.

Returns:

A long description for the command.

Default:

""

anyFlags

public abstract boolean anyFlags

Get whether any flag can be used.

The value of this property overrides flags().

Returns:

Whether all flags are accepted

Default:

false