org.eclipse.jgit.pgm
Annotation Type Command
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Command
Annotation to document a TextBuiltin
.
This is an optional annotation for TextBuiltin subclasses and it carries
documentation forward into the runtime system describing what the command is
and why users may want to invoke it.
Optional Element Summary |
boolean |
common
|
java.lang.String |
name
|
java.lang.String |
usage
|
name
public abstract java.lang.String name
- Returns:
- name the command is invoked as from the command line. If the
(default) empty string is supplied the name will be generated
from the class name.
- Default:
- ""
usage
public abstract java.lang.String usage
- Returns:
- one line description of the command's feature set.
- Default:
- ""
common
public abstract boolean common
- Returns:
- true if this command is considered to be commonly used.
- Default:
- false
Copyright © 2011. All Rights Reserved.