org.eclipse.jgit.pgm

Class CommandRef

java.lang.Object

org.eclipse.jgit.pgm.CommandRef

public class CommandRef
extends Object

Description of a command (a TextBuiltin subclass.

These descriptions are lightweight compared to creating a command instance and are therefore suitable for catalogs of "known" commands without linking the command's implementation and creating a dummy instance of the command.

Method Summary

Methods

Modifier and Type	Method and Description
TextBuiltin	create()
ClassLoader	getImplementationClassLoader()
String	getImplementationClassName()
String	getName()
String	getUsage()
boolean	isCommon()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

Returns:

name the command is invoked as from the command line.

getUsage

public String getUsage()

Returns:

one line description of the command's feature set.

isCommon

public boolean isCommon()

Returns:

true if this command is considered to be commonly used.

getImplementationClassName

public String getImplementationClassName()

Returns:

name of the Java class which implements this command.

getImplementationClassLoader

public ClassLoader getImplementationClassLoader()

Returns:

loader for getImplementationClassName().

create

public TextBuiltin create()

Returns:

a new instance of the command implementation.