|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Target(value={TYPE,METHOD}) public @interface Command
Marks a method or an object as an executable command.
Optional Element Summary | |
---|---|
String[] |
aliases
Returns the aliases used to invoke this command. |
String |
description
Returns a brief description for the command. |
boolean |
disabled
True if the command should be disabled. |
String |
displayName
Returns a display name for the command. |
String[] |
group
The group to which a command belongs. |
boolean |
hidden
True if the command should be hidden from the usage. |
String |
name
Returns the name of the command. |
boolean |
parseOptions
Can be set to false to skip options (-?) |
public abstract String description
public abstract String name
If this parameter is omitted on an annotated Method then the name will default to the method name.
If this parameter is omitted on an annotated Class, then the name will be the name of the class.
public abstract String displayName
This value can be used by user interfaces in place of
the actual command name. When this value is omitted,
the name()
should be used.
public abstract String[] aliases
public abstract boolean hidden
public abstract boolean disabled
public abstract boolean parseOptions
public abstract String[] group
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |