Element Detail

• aliases

  public abstract java.lang.String[] aliases

  A list of aliases for the command. The first alias is the most important -- it is the main name of the command. (The method name is never used for anything).

  Returns:

  Aliases for a command

• desc

  public abstract java.lang.String desc

  Returns:

  A short description for the command.

• usage

  public abstract java.lang.String usage

  Usage instruction. Example text for usage could be [-h harps] [name] [message].

  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 java.lang.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

  Default:

  ""

• help

  public abstract java.lang.String help

  Returns:

  A long description for the command.

  Default:

  ""

• anyFlags

  public abstract boolean anyFlags

  Get whether any flag can be used.

  Returns:

  true if so

  Default:

  false