JGit 7.2.0.202503040940-r · org.eclipse.jgit.api.CommitCommand

Modifier and Type	Field and Description
private boolean	all
private Boolean	allowEmpty
private boolean	amend
private PersonIdent	author
private boolean	cleanDefaultIsStrip
private CommitConfig.CleanupMode	cleanupMode
private Character	commentChar
private PersonIdent	committer
private CredentialsProvider	credentialsProvider
private GpgConfig	gpgConfig
private HashMap<String, PrintStream>	hookErrRedirect
private HashMap<String, PrintStream>	hookOutRedirect
private boolean	insertChangeId
private static final Logger	log
private String	message
private boolean	noVerify Setting this option bypasses the pre-commit and commit-msg hooks.
private List<String>	only
private boolean[]	onlyProcessed
private List<ObjectId>	parents parents this commit should have.
private String	reflogComment
private Boolean	signCommit
private Signer	signer
private String	signingKey
private boolean	useDefaultReflogMessage

Access	Constructor and Description
protected	CommitCommand(Repository the `org.eclipse.jgit.lib.Repository` repo) Constructor for CommitCommand

Method Summary

Modifier and Type	Method and Description
public RevCommit	call() Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
private void	checkIfEmpty(RevWalk rw, ObjectId headId, ObjectId indexTreeId)
private DirCache	createTemporaryIndex(ObjectId headId, DirCache index, RevWalk rw)
public PersonIdent	Returns: the author used for the `commit`. If no author was specified `null` is returned and the default `org.eclipse.jgit.lib.PersonIdent` of this repo is used during execution of the command getAuthor() Get the author
public PersonIdent	Returns: the committer used for the `commit`. If no committer was specified `null` is returned and the default `org.eclipse.jgit.lib.PersonIdent` of this repo is used during execution of the command getCommitter() Get the committer
public String	Returns: the commit message used for the `commit` getMessage() Get the commit message
private void	insertChangeId(ObjectId treeId)
private boolean	isMergeDuringRebase(RepositoryState state)
private int	Returns: the item's index in `only`; -1 if no item matches lookupOnly(String entry's path pathString) Look an entry's path up in the list of paths specified by the --only/ -o option In case the complete (file) path (e.g. "d1/d2/f1") cannot be found in `only`, lookup is also tried with (parent) directory paths (e.g. "d1/d2" and "d1").
private void	processOptions(RepositoryState the state of the repository we are working on state, RevWalk the RevWalk to use rw) Sets default values for not explicitly specified options.
public CommitCommand	Returns: `this` setAll(boolean whether to auto-stage all files that have been modified and deleted all) If set to true the Commit command automatically stages files that have been modified and deleted, but new files not known by the repository are not affected.
public CommitCommand	Returns: `this` setAllowEmpty(boolean whether it should be allowed to create a commit which has the same tree as it's sole predecessor (a commit which doesn't change anything). By default when creating standard commits (without specifying paths) JGit allows to create such commits. When this flag is set to false an attempt to create an "empty" standard commit will lead to an EmptyCommitException. By default when creating a commit containing only specified paths an attempt to create an empty commit leads to a `org.eclipse.jgit.api.errors.JGitInternalException`. By setting this flag to `true` this exception will not be thrown. allowEmpty) Set whether to allow to create an empty commit
public CommitCommand	Returns: `this` setAmend(boolean whether to amend the tip of the current branch amend) Used to amend the tip of the current branch.
public CommitCommand	Returns: `this` setAuthor(PersonIdent the author used for the `commit` author) Sets the author for this `commit`.
public CommitCommand	Returns: `this` setAuthor(String the name of the author used for the `commit` name, String the email of the author used for the `commit` email) Sets the author for this `commit`.
public CommitCommand	Returns: `this` setCleanupMode(CommitConfig.CleanupMode `CleanupMode` to set mode) Sets the `CleanupMode` to apply to the commit message.
public CommitCommand	Returns: `this` setCommentCharacter(Character the comment character, or `null` to use the value from the git config commentChar) Sets the comment character to apply when cleaning a commit message.
public CommitCommand	Returns: `this` setCommitter(PersonIdent the committer used for the `commit` committer) Sets the committer for this `commit`.
public CommitCommand	Returns: `this` setCommitter(String the name of the committer used for the `commit` name, String the email of the committer used for the `commit` email) Sets the committer for this `commit`.
public CommitCommand	Returns: `this` setCredentialsProvider(CredentialsProvider the provider to use when querying for credentials (eg., during signing) credentialsProvider) Sets a `CredentialsProvider`
public CommitCommand	Returns: `this` setDefaultClean(boolean if `true`, default to `CleanupMode#STRIP`; otherwise default to `CleanupMode#WHITESPACE` strip) Sets the default clean mode if `setCleanupMode(CleanupMode.DEFAULT)` is set and git config `commit.cleanup = default` or is not set.
public CommitCommand	Returns: `this` setGpgConfig(GpgConfig to set; if `null`, the config will be loaded from the git config of the repository config) Sets an external `GpgConfig` to use.
public CommitCommand	Returns: `this` setHookErrorStream(PrintStream the error stream for hook scripts executed by this command hookStdErr) Set the error stream for all hook scripts executed by this command (pre-commit, commit-msg, post-commit).
public CommitCommand	Returns: `this` setHookErrorStream(String name of the hook to set the output stream for hookName, PrintStream the output stream to use for the selected hook hookStdErr) Set the error stream for a selected hook script executed by this command (pre-commit, commit-msg, post-commit).
public CommitCommand	Returns: `this` setHookOutputStream(PrintStream the output stream for hook scripts executed by this command hookStdOut) Set the output stream for all hook scripts executed by this command (pre-commit, commit-msg, post-commit).
public CommitCommand	Returns: `this` setHookOutputStream(String name of the hook to set the output stream for hookName, PrintStream the output stream to use for the selected hook hookStdOut) Set the output stream for a selected hook script executed by this command (pre-commit, commit-msg, post-commit).
public CommitCommand	Returns: `this` setInsertChangeId(boolean whether to insert a change id insertChangeId) If set to true a change id will be inserted into the commit message An existing change id is not replaced.
public CommitCommand	Returns: `this` setMessage(String the commit message used for the `commit` message) Set the commit message
public CommitCommand	Returns: `this` setNoVerify(boolean Whether this commit should be verified by the pre-commit and commit-msg hooks. noVerify) Sets the `noVerify` option on this commit command.
public CommitCommand	Returns: `this` setOnly(String path to commit (with `/` as separator) only) Commit dedicated path only.
public CommitCommand	Returns: `this` setReflogComment(String the comment to be written into the reflog or `null` to specify that no reflog should be written reflogComment) Override the message written to the reflog
public CommitCommand	Returns: `this` setSign(Boolean `true` to sign, `false` to not sign and `null` for default behavior (read from configuration) sign) Sets whether the commit should be signed.
public CommitCommand	Returns: `this` setSigner(Signer to use; if `null`, the default signer will be used signer) Sets the `Signer` to use if the commit is to be signed.
public CommitCommand	Returns: `this` setSigningKey(String signing key (maybe `null`) signingKey) Sets the signing key Per spec of user.signingKey: this will be sent to the GPG program as is, i.e. can be anything supported by the GPG program.
private void	sign(CommitBuilder commit)
private void	updateRef(RepositoryState state, ObjectId headId, RevCommit revCommit, ObjectId commitId)

Inherited from org.eclipse.jgit.api.GitCommand:: checkCallable getRepository setCallable

all	back to summary
private boolean all

allowEmpty	back to summary
private Boolean allowEmpty

amend	back to summary
private boolean amend

author	back to summary
private PersonIdent author

cleanDefaultIsStrip	back to summary
private boolean cleanDefaultIsStrip

cleanupMode	back to summary
private CommitConfig.CleanupMode cleanupMode Annotations @NonNull

commentChar	back to summary
private Character commentChar

committer	back to summary
private PersonIdent committer

credentialsProvider	back to summary
private CredentialsProvider credentialsProvider

gpgConfig	back to summary
private GpgConfig gpgConfig

hookErrRedirect	back to summary
private HashMap<String, PrintStream> hookErrRedirect

hookOutRedirect	back to summary
private HashMap<String, PrintStream> hookOutRedirect

insertChangeId	back to summary
private boolean insertChangeId

log	back to summary
private static final Logger log

message	back to summary
private String message

noVerify	back to summary
private boolean noVerify Setting this option bypasses the pre-commit and commit-msg hooks.

only	back to summary
private List<String> only

onlyProcessed	back to summary
private boolean[] onlyProcessed

parents	back to summary
private List<ObjectId> parents parents this commit should have. The current HEAD will be in this list and also all commits mentioned in .git/MERGE_HEAD

reflogComment	back to summary
private String reflogComment

signCommit	back to summary
private Boolean signCommit

signer	back to summary
private Signer signer

signingKey	back to summary
private String signingKey

useDefaultReflogMessage	back to summary
private boolean useDefaultReflogMessage

CommitCommand	back to summary
protected CommitCommand(Repository repo) Constructor for CommitCommand Parameters repo:Repository the `org.eclipse.jgit.lib.Repository`

Method Detail

call back to summary

call	back to summary
public RevCommit call() throws GitAPIException, AbortedByHookException, ConcurrentRefUpdateException, NoHeadException, NoMessageException, ServiceUnavailableException, UnmergedPathsException, WrongRepositoryStateException Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Doc from org.eclipse.jgit.api.GitCommand.call. Computes a result, or throws an exception if unable to do so. Execute the command Executes the `commit` command with all the options and parameters collected by the setter methods of this class. Each instance of this class should only be used for one invocation of the command (means: one call to `call()`) Returns:RevCommit Doc from java.util.concurrent.Callable.call. computed result Annotations @Override Exceptions ServiceUnavailableException: if signing service is not available e.g. since it isn't installed

public RevCommit call() throws GitAPIException, AbortedByHookException, ConcurrentRefUpdateException, NoHeadException, NoMessageException, ServiceUnavailableException, UnmergedPathsException, WrongRepositoryStateException

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Doc from org.eclipse.jgit.api.GitCommand.call.

Computes a result, or throws an exception if unable to do so.

Execute the command

Executes the commit command with all the options and parameters collected by the setter methods of this class. Each instance of this class should only be used for one invocation of the command (means: one call to call())

Returns:RevCommit

Doc from java.util.concurrent.Callable.call.

computed result

Annotations

@Override

Exceptions

ServiceUnavailableException:: if signing service is not available e.g. since it isn't installed

checkIfEmpty	back to summary
private void checkIfEmpty(RevWalk rw, ObjectId headId, ObjectId indexTreeId) throws EmptyCommitException, MissingObjectException, IncorrectObjectTypeException, IOException

createTemporaryIndex	back to summary
private DirCache createTemporaryIndex(ObjectId headId, DirCache index, RevWalk rw) throws IOException

getAuthor back to summary

getAuthor	back to summary
public PersonIdent getAuthor() Get the author Returns:PersonIdent the author used for the `commit`. If no author was specified `null` is returned and the default `org.eclipse.jgit.lib.PersonIdent` of this repo is used during execution of the command

public PersonIdent getAuthor()

Get the author

Returns:PersonIdent: the author used for the commit. If no author was specified null is returned and the default org.eclipse.jgit.lib.PersonIdent of this repo is used during execution of the command

getCommitter back to summary

getCommitter	back to summary
public PersonIdent getCommitter() Get the committer Returns:PersonIdent the committer used for the `commit`. If no committer was specified `null` is returned and the default `org.eclipse.jgit.lib.PersonIdent` of this repo is used during execution of the command

public PersonIdent getCommitter()

Get the committer

Returns:PersonIdent: the committer used for the commit. If no committer was specified null is returned and the default org.eclipse.jgit.lib.PersonIdent of this repo is used during execution of the command

getMessage back to summary

getMessage	back to summary
public String getMessage() Get the commit message Returns:String the commit message used for the `commit`

public String getMessage()

Get the commit message

Returns:String: the commit message used for the commit

insertChangeId	back to summary
private void insertChangeId(ObjectId treeId)

isMergeDuringRebase	back to summary
private boolean isMergeDuringRebase(RepositoryState state)

lookupOnly back to summary

lookupOnly	back to summary
private int lookupOnly(String pathString) Look an entry's path up in the list of paths specified by the --only/ -o option In case the complete (file) path (e.g. "d1/d2/f1") cannot be found in `only`, lookup is also tried with (parent) directory paths (e.g. "d1/d2" and "d1"). Parameters pathString:String entry's path Returns:int the item's index in `only`; -1 if no item matches

private int lookupOnly(String pathString)

Look an entry's path up in the list of paths specified by the --only/ -o option In case the complete (file) path (e.g. "d1/d2/f1") cannot be found in only, lookup is also tried with (parent) directory paths (e.g. "d1/d2" and "d1").

Parameters

pathString:String: entry's path

Returns:int

the item's index in only; -1 if no item matches

processOptions	back to summary
private void processOptions(RepositoryState state, RevWalk rw) throws NoMessageException, UnsupportedSigningFormatException Sets default values for not explicitly specified options. Then validates that all required data has been provided. Parameters state:RepositoryState the state of the repository we are working on rw:RevWalk the RevWalk to use Exceptions NoMessageException: if the commit message has not been specified UnsupportedSigningFormatException: if the configured gpg.format is not supported

processOptions

back to summary

private void processOptions(RepositoryState state, RevWalk rw) throws NoMessageException, UnsupportedSigningFormatException

Sets default values for not explicitly specified options. Then validates that all required data has been provided.

Parameters

state:RepositoryState: the state of the repository we are working on
rw:RevWalk: the RevWalk to use

Exceptions

NoMessageException:: if the commit message has not been specified
UnsupportedSigningFormatException:: if the configured gpg.format is not supported

setAll back to summary

setAll	back to summary
public CommitCommand setAll(boolean all) If set to true the Commit command automatically stages files that have been modified and deleted, but new files not known by the repository are not affected. This corresponds to the parameter -a on the command line. Parameters all:boolean whether to auto-stage all files that have been modified and deleted Returns:CommitCommand `this` Exceptions JGitInternalException: in case of an illegal combination of arguments/ options

public CommitCommand setAll(boolean all)

If set to true the Commit command automatically stages files that have been modified and deleted, but new files not known by the repository are not affected. This corresponds to the parameter -a on the command line.

Parameters

all:boolean: whether to auto-stage all files that have been modified and deleted

public Class CommitCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail