Top Description Methods
org.eclipse.jgit.pgm

public @Interface Command

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME
Annotation to document a org.eclipse.jgit.pgm.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.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if this command is considered to be commonly used.
common()

If this command is considered to be commonly used

public String

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.
name()

Get the command name

public String

Returns:

one line description of the command's feature set.
usage()

Get command description

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

commonback to summary
public boolean common()

If this command is considered to be commonly used

Returns:boolean

true if this command is considered to be commonly used.

nameback to summary
public String name()

Get the command name

Returns:String

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.

usageback to summary
public String usage()

Get command description

Returns:String

one line description of the command's feature set.