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

Common superclass of all commands in the package org.eclipse.jgit.api

This class ensures that all commands fulfill the java.util.concurrent.Callable interface. It also has a property repo holding a reference to the git org.eclipse.jgit.lib.Repository this command should work with.

Finally this class stores a state telling whether it is allowed to call call() on this instance. Instances of org.eclipse.jgit.api.GitCommand can only be used for one single successful call to call(). Afterwards this instance may not be used anymore to set/modify any properties or to call call() again. This is achieved by setting the callable property to false after the successful execution of call() and to check the state (by calling checkCallable()) before setting of properties and inside call().

Field Summary

Modifier and Type	Field and Description
private AtomicBoolean	callable a state which tells whether it is allowed to call `call()` on this instance.
protected final Repository	repo The repository this command is working with

Constructor Summary

Access	Constructor and Description
protected	GitCommand(Repository the `org.eclipse.jgit.lib.Repository` this command should interact with repo) Creates a new command which interacts with a single repository

Method Summary

Modifier and Type	Method and Description
public abstract T	call() Redeclares java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
protected void	checkCallable() Checks that the property `callable` is `true`.
public Repository	Returns: the `org.eclipse.jgit.lib.Repository` this command is interacting with getRepository() Get repository this command is working on
protected void	setCallable(boolean if `true` it is allowed to call `call()` on this instance. callable) Set's the state which tells whether it is allowed to call `call()` on this instance.

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

Field Detail

callable	back to summary
private AtomicBoolean callable a state which tells whether it is allowed to call `call()` on this instance.

repo	back to summary
protected final Repository repo The repository this command is working with

Constructor Detail

GitCommand back to summary

GitCommand	back to summary
protected GitCommand(Repository repo) Creates a new command which interacts with a single repository Parameters repo:Repository the `org.eclipse.jgit.lib.Repository` this command should interact with

protected GitCommand(Repository repo)

Creates a new command which interacts with a single repository

Parameters

repo:Repository: the org.eclipse.jgit.lib.Repository this command should interact with

Method Detail

call	back to summary
public abstract T call() throws GitAPIException Redeclares java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Execute the command Returns:T computed result Annotations @Override

call

back to summary

public abstract T call() throws GitAPIException

Redeclares java.util.concurrent.Callable.call.

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

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

Execute the command

Returns:T

computed result

Annotations

@Override

checkCallable back to summary

checkCallable	back to summary
protected void checkCallable() Checks that the property `callable` is `true`. If not then an `java.lang.IllegalStateException` is thrown Exceptions IllegalStateException: when this method is called and the property `callable` is `false`

protected void checkCallable()

Checks that the property callable is true. If not then an java.lang.IllegalStateException is thrown

Exceptions

IllegalStateException:: when this method is called and the property callable is false

getRepository back to summary

getRepository	back to summary
public Repository getRepository() Get repository this command is working on Returns:Repository the `org.eclipse.jgit.lib.Repository` this command is interacting with

public Repository getRepository()

Get repository this command is working on

Returns:Repository: the org.eclipse.jgit.lib.Repository this command is interacting with

setCallable back to summary

setCallable	back to summary
protected void setCallable(boolean callable) Set's the state which tells whether it is allowed to call `call()` on this instance. `checkCallable()` will throw an exception when called and this property is set to `false` Parameters callable:boolean if `true` it is allowed to call `call()` on this instance.

protected void setCallable(boolean callable)

Set's the state which tells whether it is allowed to call call() on this instance. checkCallable() will throw an exception when called and this property is set to false