Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	TextBuiltin.TerminatedByHelpException Exception thrown by `TextBuiltin` if it proceeds 'help' option

Field Summary

Modifier and Type	Field and Description
protected RevWalk	argWalk RevWalk used during command line parsing, if it was required.
private String	commandName
protected Repository	db Git repository the command was invoked within.
protected OutputStream	errs Error output stream, typically this is standard error.
protected ThrowingPrintWriter	errw Error writer, typically this is standard error.
protected String	gitdir Directory supplied via --git-dir command line option.
private boolean	help
protected InputStream	ins Input stream, typically this is standard input.
protected OutputStream	outs Stream to output to, typically this is standard output.
protected ThrowingPrintWriter	outw Writer to output to, typically this is standard output.
private SshDriver	sshDriver

Constructor Summary

Access	Constructor and Description
public	TextBuiltin()

Method Summary

Modifier and Type	Method and Description
pack-priv String	abbreviateRef(String dst, boolean abbreviateRemote)
public static boolean	Returns: true if the given array contains help option containsHelp(String[] non null args) Check if the arguments contain a help option
protected static Die	Returns: a runtime exception the caller is expected to throw die(String textual explanation why) Exit the command with an error message
protected static Die	Returns: a runtime exception the caller is expected to throw die(String textual explanation why, Throwable why the command has failed. cause) Exit the command with an error message and an exception
protected static Die	Returns: a runtime exception the caller is expected to throw die(boolean boolean indicating that the execution has been aborted before running aborted) Exit the command
protected static Die	Returns: a runtime exception the caller is expected to throw die(boolean boolean indicating that the execution has been aborted before running aborted, Throwable why the command has failed. cause) Exit the command
public final void	execute(String[] command line arguments passed after the command name. args) Parse arguments and run this command.
public ThrowingPrintWriter	Returns: error writer, typically this is standard error. getErrorWriter() Get error writer
private Charset	Returns: Charset corresponding to `i18n.logOutputEncoding`, or `UTF_8`. getLogOutputEncodingCharset(Repository the repository. repository) Get the log output encoding specified in the repository's `i18n.logOutputEncoding` configuration.
public ThrowingPrintWriter	Returns: output writer, typically this is standard output. getOutputWriter() Get output writer
public Repository	Returns: the repository this command accesses. getRepository() Get the repository
protected ResourceBundle	Returns: the resource bundle that will be passed to args4j for purpose of string localization getResourceBundle() Get resource bundle with localized texts
protected void	init(Repository the opened repository that the command should work on. repository, String value of the `--git-dir` command line option, if `repository` is null. gitDir) Initialize the command to work with a repository.
public void	initRaw(final Repository the opened repository that the command should work on. repository, final String value of the `--git-dir` command line option, if `repository` is null. gitDir, InputStream input stream from which input will be read input, OutputStream output stream to which output will be written output, OutputStream error stream to which errors will be written error) Initializes the command to work with a repository, including setting the output and error streams.
protected void	parseArguments(String[] the arguments supplied on the command line, if any. args) Parses the command line arguments prior to running.
protected void	printUsage(String non null message, CmdLineParser parser used to print options clp) Print usage help text.
public void	printUsageAndExit(CmdLineParser a `org.eclipse.jgit.pgm.opt.CmdLineParser` object. clp) Print the usage line
public void	printUsageAndExit(String a `java.lang.String` object. message, CmdLineParser a `org.eclipse.jgit.pgm.opt.CmdLineParser` object. clp) Print an error message and the usage line
protected boolean	Returns: true if `db`/`getRepository()` is required requiresRepository() If this command requires a repository.
pack-priv ObjectId	resolve(String s)
protected abstract void	run() Perform the actions of this command.
pack-priv final void	setCommandName(String name)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argWalk	back to summary
protected RevWalk argWalk RevWalk used during command line parsing, if it was required.

commandName	back to summary
private String commandName

db	back to summary
protected Repository db Git repository the command was invoked within.

errs	back to summary
protected OutputStream errs Error output stream, typically this is standard error. Since 3.4

errs

back to summary

protected OutputStream errs

Error output stream, typically this is standard error.

Since: 3.4

errw	back to summary
protected ThrowingPrintWriter errw Error writer, typically this is standard error. Since 3.4

errw

back to summary

protected ThrowingPrintWriter errw

Error writer, typically this is standard error.

Since: 3.4

gitdir	back to summary
protected String gitdir Directory supplied via --git-dir command line option.

help	back to summary
private boolean help Annotations @Option name:--help usage:usage_displayThisHelpText aliases:-h

ins	back to summary
protected InputStream ins Input stream, typically this is standard input. Since 3.4

ins

back to summary

protected InputStream ins

Input stream, typically this is standard input.

Since: 3.4

outs	back to summary
protected OutputStream outs Stream to output to, typically this is standard output. Since 2.2

outs

back to summary

protected OutputStream outs

Stream to output to, typically this is standard output.

Since: 2.2

outw	back to summary
protected ThrowingPrintWriter outw Writer to output to, typically this is standard output. Since 2.2

outw

back to summary

protected ThrowingPrintWriter outw

Writer to output to, typically this is standard output.

Since: 2.2

sshDriver	back to summary
private SshDriver sshDriver Annotations @Option name:--ssh usage:usage_sshDriver

Constructor Detail

TextBuiltin	back to summary
public TextBuiltin()

Method Detail

abbreviateRef	back to summary
pack-priv String abbreviateRef(String dst, boolean abbreviateRemote)

containsHelp	back to summary
public static boolean containsHelp(String[] args) Check if the arguments contain a help option Parameters args:String[] non null Returns:boolean true if the given array contains help option Since 4.2

containsHelp

back to summary

public static boolean containsHelp(String[] args)

Check if the arguments contain a help option

Parameters

args:String[]: non null

Returns:boolean

true if the given array contains help option

Since

4.2

die	back to summary
protected static Die die(String why) Exit the command with an error message Parameters why:String textual explanation Returns:Die a runtime exception the caller is expected to throw

die

back to summary

protected static Die die(String why)

Exit the command with an error message

Parameters

why:String: textual explanation

Returns:Die

a runtime exception the caller is expected to throw

die	back to summary
protected static Die die(String why, Throwable cause) Exit the command with an error message and an exception Parameters why:String textual explanation cause:Throwable why the command has failed. Returns:Die a runtime exception the caller is expected to throw

die

back to summary

protected static Die die(String why, Throwable cause)

Exit the command with an error message and an exception

Parameters

why:String: textual explanation
cause:Throwable: why the command has failed.

Returns:Die

a runtime exception the caller is expected to throw

die	back to summary
protected static Die die(boolean aborted) Exit the command Parameters aborted:boolean boolean indicating that the execution has been aborted before running Returns:Die a runtime exception the caller is expected to throw Since 3.4

die

back to summary

protected static Die die(boolean aborted)

Exit the command

Parameters

aborted:boolean: boolean indicating that the execution has been aborted before running

Returns:Die

a runtime exception the caller is expected to throw

Since

3.4

die	back to summary
protected static Die die(boolean aborted, Throwable cause) Exit the command Parameters aborted:boolean boolean indicating that the execution has been aborted before running cause:Throwable why the command has failed. Returns:Die a runtime exception the caller is expected to throw Since 4.2

die

back to summary

protected static Die die(boolean aborted, Throwable cause)

Exit the command

Parameters

aborted:boolean: boolean indicating that the execution has been aborted before running
cause:Throwable: why the command has failed.

Returns:Die

a runtime exception the caller is expected to throw

Since

4.2

execute	back to summary
public final void execute(String[] args) throws Exception Parse arguments and run this command. Parameters args:String[] command line arguments passed after the command name. Exceptions Exception: an error occurred while processing the command. The main framework will catch the exception and print a message on standard error.

execute

back to summary

public final void execute(String[] args) throws Exception

Parse arguments and run this command.

Parameters

args:String[]: command line arguments passed after the command name.

Exceptions

Exception:: an error occurred while processing the command. The main framework will catch the exception and print a message on standard error.

getErrorWriter	back to summary
public ThrowingPrintWriter getErrorWriter() Get error writer Returns:ThrowingPrintWriter error writer, typically this is standard error. Since 4.2

getErrorWriter

back to summary

public ThrowingPrintWriter getErrorWriter()

Get error writer

Returns:ThrowingPrintWriter: error writer, typically this is standard error.
Since: 4.2

getLogOutputEncodingCharset back to summary

getLogOutputEncodingCharset	back to summary
private Charset getLogOutputEncodingCharset(Repository repository) Get the log output encoding specified in the repository's `i18n.logOutputEncoding` configuration. Parameters repository:Repository the repository. Returns:Charset Charset corresponding to `i18n.logOutputEncoding`, or `UTF_8`.

private Charset getLogOutputEncodingCharset(Repository repository)

Get the log output encoding specified in the repository's i18n.logOutputEncoding configuration.

Parameters

repository:Repository: the repository.

Returns:Charset

Charset corresponding to i18n.logOutputEncoding, or UTF_8.

getOutputWriter	back to summary
public ThrowingPrintWriter getOutputWriter() Get output writer Returns:ThrowingPrintWriter output writer, typically this is standard output. Since 4.9

getOutputWriter

back to summary

public ThrowingPrintWriter getOutputWriter()

Get output writer

Returns:ThrowingPrintWriter: output writer, typically this is standard output.
Since: 4.9

getRepository	back to summary
public Repository getRepository() Get the repository Returns:Repository the repository this command accesses.

getRepository

back to summary

public Repository getRepository()

Get the repository

Returns:Repository: the repository this command accesses.

getResourceBundle	back to summary
protected ResourceBundle getResourceBundle() Get resource bundle with localized texts Returns:ResourceBundle the resource bundle that will be passed to args4j for purpose of string localization

getResourceBundle

back to summary

protected ResourceBundle getResourceBundle()

Get resource bundle with localized texts

Returns:ResourceBundle: the resource bundle that will be passed to args4j for purpose of string localization

init back to summary

init	back to summary
protected void init(Repository repository, String gitDir) Initialize the command to work with a repository. Parameters repository:Repository the opened repository that the command should work on. gitDir:String value of the `--git-dir` command line option, if `repository` is null.

protected void init(Repository repository, String gitDir)

Initialize the command to work with a repository.

Parameters

repository:Repository: the opened repository that the command should work on.
gitDir:String: value of the --git-dir command line option, if repository is null.

initRaw back to summary

initRaw	back to summary
public void initRaw(final Repository repository, final String gitDir, InputStream input, OutputStream output, OutputStream error) Initializes the command to work with a repository, including setting the output and error streams. Parameters repository:Repository the opened repository that the command should work on. gitDir:String value of the `--git-dir` command line option, if `repository` is null. input:InputStream input stream from which input will be read output:OutputStream output stream to which output will be written error:OutputStream error stream to which errors will be written Since 4.9

public void initRaw(final Repository repository, final String gitDir, InputStream input, OutputStream output, OutputStream error)

Initializes the command to work with a repository, including setting the output and error streams.

Parameters

repository:Repository: the opened repository that the command should work on.
gitDir:String: value of the --git-dir command line option, if repository is null.
input:InputStream: input stream from which input will be read
output:OutputStream: output stream to which output will be written
error:OutputStream: error stream to which errors will be written

Since

4.9

parseArguments back to summary

parseArguments	back to summary
protected void parseArguments(String[] args) throws IOException Parses the command line arguments prior to running. This method should only be invoked by `execute(String[])`, prior to calling `run()`. The default implementation parses all arguments into this object's instance fields. Parameters args:String[] the arguments supplied on the command line, if any. Exceptions IOException: if an IO error occurred

protected void parseArguments(String[] args) throws IOException

Parses the command line arguments prior to running.

This method should only be invoked by execute(String[]), prior to calling run(). The default implementation parses all arguments into this object's instance fields.

Parameters

args:String[]: the arguments supplied on the command line, if any.

Exceptions

IOException:: if an IO error occurred

printUsage	back to summary
protected void printUsage(String message, CmdLineParser clp) throws IOException Print usage help text. Parameters message:String non null clp:CmdLineParser parser used to print options Exceptions IOException: if an IO error occurred Since 4.2

printUsage

back to summary

protected void printUsage(String message, CmdLineParser clp) throws IOException

Print usage help text.

Parameters

message:String: non null
clp:CmdLineParser: parser used to print options

Exceptions

IOException:: if an IO error occurred

Since

4.2

printUsageAndExit back to summary

printUsageAndExit	back to summary
public void printUsageAndExit(CmdLineParser clp) throws IOException Print the usage line Parameters clp:CmdLineParser a `org.eclipse.jgit.pgm.opt.CmdLineParser` object. Exceptions IOException: if an IO error occurred

public void printUsageAndExit(CmdLineParser clp) throws IOException

Print the usage line

Parameters

clp:CmdLineParser: a org.eclipse.jgit.pgm.opt.CmdLineParser object.

Exceptions

IOException:: if an IO error occurred

printUsageAndExit back to summary

printUsageAndExit	back to summary
public void printUsageAndExit(String message, CmdLineParser clp) throws IOException Print an error message and the usage line Parameters message:String a `java.lang.String` object. clp:CmdLineParser a `org.eclipse.jgit.pgm.opt.CmdLineParser` object. Exceptions IOException: if an IO error occurred

public void printUsageAndExit(String message, CmdLineParser clp) throws IOException

Print an error message and the usage line

Parameters

message:String: a java.lang.String object.
clp:CmdLineParser: a org.eclipse.jgit.pgm.opt.CmdLineParser object.

Exceptions

IOException:: if an IO error occurred

requiresRepository back to summary

requiresRepository	back to summary
protected boolean requiresRepository() If this command requires a repository. Returns:boolean true if `db`/`getRepository()` is required

protected boolean requiresRepository()

If this command requires a repository.

Returns:boolean: true if db/getRepository() is required

resolve	back to summary
pack-priv ObjectId resolve(String s) throws IOException

run back to summary

run	back to summary
protected abstract void run() throws Exception Perform the actions of this command. This method should only be invoked by `execute(String[])`. Exceptions Exception: an error occurred while processing the command. The main framework will catch the exception and print a message on standard error.

protected abstract void run() throws Exception

Perform the actions of this command.

This method should only be invoked by execute(String[]).

Exceptions

Exception:: an error occurred while processing the command. The main framework will catch the exception and print a message on standard error.

setCommandName	back to summary
pack-priv final void setCommandName(String name)

org.eclipse.jgit.pgm back to summary

public Class TextBuiltin.TerminatedByHelpException

Class Inheritance

extends Die

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.eclipse.jgit.pgm.Die
org.eclipse.jgit.pgm.TextBuiltin.TerminatedByHelpException

Exception thrown by TextBuiltin if it proceeds 'help' option

Since: 4.2

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.eclipse.jgit.pgm.Die.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	TerminatedByHelpException() Default constructor

Method Summary

Inherited from org.eclipse.jgit.pgm.Die:: isAborted

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.eclipse.jgit.pgm.Die.serialVersionUID.

Constructor Detail

TerminatedByHelpException	back to summary
public TerminatedByHelpException() Default constructor

public abstract Class TextBuiltin

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TextBuiltin.TerminatedByHelpException

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail