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

Modifier and Type	Field and Description
private boolean	atomic
private boolean	dryRun
private boolean	force
private PrintStream	hookErrRedirect
private PrintStream	hookOutRedirect
private ProgressMonitor	monitor
private OutputStream	out
private PushConfig.PushDefault	pushDefault
private List<String>	pushOptions
private String	receivePack
private final Map<String, RefLeaseSpec>	refLeaseSpecs
private final List<RefSpec>	refSpecs
private String	remote
private boolean	thin
private boolean	useBitmaps

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

Method Summary

Modifier and Type	Method and Description
public PushCommand	Returns: `this`. add(Ref the source reference. The remote name will match. ref) Add a reference to push.
public PushCommand	Returns: `this`. add(String any reference name, or a reference specification. nameOrSpec) Add a reference to push.
public Iterable<PushResult>	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	determineDefaultRefSpecs(Config config)
private String	determineRemote(Config config, String remoteName)
private String	getCurrentBranch()
public ProgressMonitor	Returns: the progress monitor for the push operation getProgressMonitor() Get the progress monitor
public PushConfig.PushDefault	Returns: the `PushDefault`, or `null` if not set getPushDefault() Retrieves the `PushDefault` currently set.
public List<String>	Returns: the option strings associated with the push operation getPushOptions() Get push options
public String	Returns: the receive-pack used for the remote operation getReceivePack() Get the name of the remote executable providing the receive-pack service
public List<RefLeaseSpec>	Returns: the `RefLeaseSpec`s getRefLeaseSpecs() Get the `RefLeaseSpec`s.
public List<RefSpec>	Returns: the ref specs getRefSpecs() Get `RefSpec`s.
public String	Returns: the remote used for the remote operation getRemote() Get remote name
public int	Returns: the timeout used for the push operation getTimeout() Get timeout used for push operation
public boolean	Returns: true if all-or-nothing behavior is requested. isAtomic() Whether this push should be executed atomically (all references updated, or none)
public boolean	Returns: the dry run preference for the push operation isDryRun() Whether to run the push operation as a dry run
public boolean	Returns: the force preference for push operation isForce() Whether to push forcefully
public boolean	Returns: the thin-pack preference for push operation isThin() Get the thin-pack preference
public boolean	Returns: true if push use bitmaps. isUseBitmaps() Whether to use bitmaps for push.
public PushCommand	Returns: `this` setAtomic(boolean whether to run the push atomically atomic) Requests atomic push (all references updated, or no updates).
public PushCommand	Returns: `this` setDryRun(boolean a boolean. dryRun) Sets whether the push operation should be a dry run
public PushCommand	Returns: `this` setForce(boolean whether to push forcefully force) Sets the force preference for push operation.
public PushCommand	Returns: `this` setHookErrorStream(PrintStream `PrintStream` to use; if `null`, `System#err` will be used redirect) Sets a `PrintStream` a "pre-push" hook may write its stderr to.
public PushCommand	Returns: `this` setHookOutputStream(PrintStream `PrintStream` to use; if `null`, `System#out` will be used redirect) Sets a `PrintStream` a "pre-push" hook may write its stdout to.
public PushCommand	Returns: `this` setOutputStream(OutputStream an `java.io.OutputStream` out) Sets the output stream to write sideband messages to
public PushCommand	Returns: `this` setProgressMonitor(ProgressMonitor a `org.eclipse.jgit.lib.ProgressMonitor` monitor) The progress monitor associated with the push operation.
public PushCommand	Returns: `this` setPushAll() Push all branches under refs/heads/*.
public PushCommand	Returns: `this` setPushDefault(PushConfig.PushDefault `PushDefault` to set; if `null` the value defined in the git config will be used. pushDefault) Sets an explicit `PushDefault`.
public PushCommand	Returns: `this` setPushOptions(List<String> a `java.util.List` of push option strings pushOptions) Set the option strings associated with the push operation.
public PushCommand	Returns: `this` setPushTags() Push all tags under refs/tags/*.
public PushCommand	Returns: `this` setReceivePack(String name of the remote executable providing the receive-pack service receivePack) The remote executable providing receive-pack service for pack transports.
public PushCommand	Returns: `this` setRefLeaseSpecs(RefLeaseSpec... a `org.eclipse.jgit.transport.RefLeaseSpec` object. specs) The ref lease specs to be used in the push operation, for a force-with-lease push operation.
public PushCommand	Returns: `this` setRefLeaseSpecs(List<RefLeaseSpec> list of `RefLeaseSpec`s specs) The ref lease specs to be used in the push operation, for a force-with-lease push operation.
public PushCommand	Returns: `this` setRefSpecs(RefSpec... a `org.eclipse.jgit.transport.RefSpec` object. specs) The ref specs to be used in the push operation
public PushCommand	Returns: `this` setRefSpecs(List<RefSpec> list of `org.eclipse.jgit.transport.RefSpec`s specs) The ref specs to be used in the push operation
public PushCommand	Returns: `this` setRemote(String the remote name remote) The remote (uri or name) used for the push operation.
public PushCommand	Returns: `this` setThin(boolean the thin-pack preference value thinPack) Set the thin-pack preference for push operation.
public PushCommand	Returns: `this` setUseBitmaps(boolean false to disable use of bitmaps for push, true otherwise. useBitmaps) Set whether to use bitmaps for push.

Inherited from org.eclipse.jgit.api.TransportCommand:: configure configure self setCredentialsProvider setTimeout setTransportConfigCallback

atomic	back to summary
private boolean atomic

dryRun	back to summary
private boolean dryRun

force	back to summary
private boolean force

hookErrRedirect	back to summary
private PrintStream hookErrRedirect

hookOutRedirect	back to summary
private PrintStream hookOutRedirect

monitor	back to summary
private ProgressMonitor monitor

out	back to summary
private OutputStream out

pushDefault	back to summary
private PushConfig.PushDefault pushDefault

pushOptions	back to summary
private List<String> pushOptions

receivePack	back to summary
private String receivePack

refLeaseSpecs	back to summary
private final Map<String, RefLeaseSpec> refLeaseSpecs

refSpecs	back to summary
private final List<RefSpec> refSpecs

remote	back to summary
private String remote

thin	back to summary
private boolean thin

useBitmaps	back to summary
private boolean useBitmaps

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

Method Detail

add back to summary

add	back to summary
public PushCommand add(Ref ref) Add a reference to push. Parameters ref:Ref the source reference. The remote name will match. Returns:PushCommand `this`.

public PushCommand add(Ref ref)

Add a reference to push.

Parameters

ref:Ref: the source reference. The remote name will match.

Returns:PushCommand

this.

add back to summary

add	back to summary
public PushCommand add(String nameOrSpec) Add a reference to push. Parameters nameOrSpec:String any reference name, or a reference specification. Returns:PushCommand `this`. Exceptions JGitInternalException: the reference name cannot be resolved.

public PushCommand add(String nameOrSpec)

Add a reference to push.

Parameters

nameOrSpec:String: any reference name, or a reference specification.

Returns:PushCommand

this.

Exceptions

JGitInternalException:: the reference name cannot be resolved.

call back to summary

call	back to summary
public Iterable<PushResult> call() throws GitAPIException, InvalidRemoteException, TransportException 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 Execute the `push` 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:Iterable<PushResult> Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

public Iterable<PushResult> call() throws GitAPIException, InvalidRemoteException, TransportException

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

Execute the push 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:Iterable<PushResult>

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

computed result

Annotations

@Override

determineDefaultRefSpecs	back to summary
private void determineDefaultRefSpecs(Config config) throws IOException, GitAPIException

determineRemote	back to summary
private String determineRemote(Config config, String remoteName) throws IOException

getCurrentBranch	back to summary
private String getCurrentBranch() throws IOException, DetachedHeadException

getProgressMonitor	back to summary
public ProgressMonitor getProgressMonitor() Get the progress monitor Returns:ProgressMonitor the progress monitor for the push operation

getProgressMonitor

back to summary

public ProgressMonitor getProgressMonitor()

Get the progress monitor

Returns:ProgressMonitor: the progress monitor for the push operation

getPushDefault back to summary

getPushDefault	back to summary
public PushConfig.PushDefault getPushDefault() Retrieves the `PushDefault` currently set. Returns:PushConfig.PushDefault the `PushDefault`, or `null` if not set Since 6.1

public PushConfig.PushDefault getPushDefault()

Retrieves the PushDefault currently set.

Returns:PushConfig.PushDefault: the PushDefault, or null if not set
Since: 6.1

getPushOptions	back to summary
public List<String> getPushOptions() Get push options Returns:List<String> the option strings associated with the push operation Since 4.5

getPushOptions

back to summary

public List<String> getPushOptions()

Get push options

Returns:List<String>: the option strings associated with the push operation
Since: 4.5

getReceivePack	back to summary
public String getReceivePack() Get the name of the remote executable providing the receive-pack service Returns:String the receive-pack used for the remote operation

getReceivePack

back to summary

public String getReceivePack()

Get the name of the remote executable providing the receive-pack service

Returns:String: the receive-pack used for the remote operation

getRefLeaseSpecs back to summary

getRefLeaseSpecs	back to summary
public List<RefLeaseSpec> getRefLeaseSpecs() Get the `RefLeaseSpec`s. Returns:List<RefLeaseSpec> the `RefLeaseSpec`s Since 4.7

public List<RefLeaseSpec> getRefLeaseSpecs()

Get the RefLeaseSpecs.

Returns:List<RefLeaseSpec>: the RefLeaseSpecs
Since: 4.7

getRefSpecs back to summary

getRefSpecs	back to summary
public List<RefSpec> getRefSpecs() Get `RefSpec`s. Returns:List<RefSpec> the ref specs

public List<RefSpec> getRefSpecs()

Get RefSpecs.

Returns:List<RefSpec>: the ref specs

getRemote	back to summary
public String getRemote() Get remote name Returns:String the remote used for the remote operation

getRemote

back to summary

public String getRemote()

Get remote name

Returns:String: the remote used for the remote operation

getTimeout	back to summary
public int getTimeout() Get timeout used for push operation Returns:int the timeout used for the push operation

getTimeout

back to summary

public int getTimeout()

Get timeout used for push operation

Returns:int: the timeout used for the push operation

isAtomic	back to summary
public boolean isAtomic() Whether this push should be executed atomically (all references updated, or none) Returns:boolean true if all-or-nothing behavior is requested. Since 4.2

isAtomic

back to summary

public boolean isAtomic()

Whether this push should be executed atomically (all references updated, or none)

Returns:boolean: true if all-or-nothing behavior is requested.
Since: 4.2

isDryRun	back to summary
public boolean isDryRun() Whether to run the push operation as a dry run Returns:boolean the dry run preference for the push operation

isDryRun

back to summary

public boolean isDryRun()

Whether to run the push operation as a dry run

Returns:boolean: the dry run preference for the push operation

isForce	back to summary
public boolean isForce() Whether to push forcefully Returns:boolean the force preference for push operation

isForce

back to summary

public boolean isForce()

Whether to push forcefully

Returns:boolean: the force preference for push operation

isThin	back to summary
public boolean isThin() Get the thin-pack preference Returns:boolean the thin-pack preference for push operation

isThin

back to summary

public boolean isThin()

Get the thin-pack preference

Returns:boolean: the thin-pack preference for push operation

isUseBitmaps	back to summary
public boolean isUseBitmaps() Whether to use bitmaps for push. Returns:boolean true if push use bitmaps. Since 6.4

isUseBitmaps

back to summary

public boolean isUseBitmaps()

Whether to use bitmaps for push.

Returns:boolean: true if push use bitmaps.
Since: 6.4

setAtomic back to summary

setAtomic	back to summary
public PushCommand setAtomic(boolean atomic) Requests atomic push (all references updated, or no updates). Default setting is false. Parameters atomic:boolean whether to run the push atomically Returns:PushCommand `this` Since 4.2

public PushCommand setAtomic(boolean atomic)

Requests atomic push (all references updated, or no updates). Default setting is false.

Parameters

atomic:boolean: whether to run the push atomically

Returns:PushCommand

this

Since

4.2

setDryRun back to summary

setDryRun	back to summary
public PushCommand setDryRun(boolean dryRun) Sets whether the push operation should be a dry run Parameters dryRun:boolean a boolean. Returns:PushCommand `this`

public PushCommand setDryRun(boolean dryRun)

Sets whether the push operation should be a dry run

Parameters

dryRun:boolean: a boolean.

Returns:PushCommand

this

setForce back to summary

setForce	back to summary
public PushCommand setForce(boolean force) Sets the force preference for push operation. Parameters force:boolean whether to push forcefully Returns:PushCommand `this`

public PushCommand setForce(boolean force)

Sets the force preference for push operation.

Parameters

force:boolean: whether to push forcefully

Returns:PushCommand

this

setHookErrorStream back to summary

setHookErrorStream	back to summary
public PushCommand setHookErrorStream(PrintStream redirect) Sets a `PrintStream` a "pre-push" hook may write its stderr to. If not set, `System#err` will be used. When pushing to several remote repositories the stream is shared for all pushes. Parameters redirect:PrintStream `PrintStream` to use; if `null`, `System#err` will be used Returns:PushCommand `this` Since 6.4

public PushCommand setHookErrorStream(PrintStream redirect)

Sets a PrintStream a "pre-push" hook may write its stderr to. If not set, System#err will be used.

When pushing to several remote repositories the stream is shared for all pushes.

Parameters

redirect:PrintStream: PrintStream to use; if null, System#err will be used

Returns:PushCommand

this

Since

6.4

setHookOutputStream back to summary

setHookOutputStream	back to summary
public PushCommand setHookOutputStream(PrintStream redirect) Sets a `PrintStream` a "pre-push" hook may write its stdout to. If not set, `System#out` will be used. When pushing to several remote repositories the stream is shared for all pushes. Parameters redirect:PrintStream `PrintStream` to use; if `null`, `System#out` will be used Returns:PushCommand `this` Since 6.4

public PushCommand setHookOutputStream(PrintStream redirect)

Sets a PrintStream a "pre-push" hook may write its stdout to. If not set, System#out will be used.

When pushing to several remote repositories the stream is shared for all pushes.

Parameters

redirect:PrintStream: PrintStream to use; if null, System#out will be used

Returns:PushCommand

this

Since

6.4

setOutputStream back to summary

setOutputStream	back to summary
public PushCommand setOutputStream(OutputStream out) Sets the output stream to write sideband messages to Parameters out:OutputStream an `java.io.OutputStream` Returns:PushCommand `this` Since 3.0

public PushCommand setOutputStream(OutputStream out)

Sets the output stream to write sideband messages to

Parameters

out:OutputStream: an java.io.OutputStream

Returns:PushCommand

this

Since

3.0

setProgressMonitor back to summary

setProgressMonitor	back to summary
public PushCommand setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the push operation. By default, this is set to `NullProgressMonitor` Parameters monitor:ProgressMonitor a `org.eclipse.jgit.lib.ProgressMonitor` Returns:PushCommand `this` See Also `NullProgressMonitor`

public PushCommand setProgressMonitor(ProgressMonitor monitor)

The progress monitor associated with the push operation. By default, this is set to NullProgressMonitor

Parameters

monitor:ProgressMonitor: a org.eclipse.jgit.lib.ProgressMonitor

Returns:PushCommand

this

See Also

NullProgressMonitor

setPushAll back to summary

setPushAll	back to summary
public PushCommand setPushAll() Push all branches under refs/heads/*. Returns:PushCommand `this`

public PushCommand setPushAll()

Push all branches under refs/heads/*.

Returns:PushCommand: this

setPushDefault back to summary

setPushDefault	back to summary
public PushCommand setPushDefault(PushConfig.PushDefault pushDefault) Sets an explicit `PushDefault`. The default used if this is not called is `PushDefault#CURRENT` for compatibility reasons with earlier JGit versions. Parameters pushDefault:PushConfig.PushDefault `PushDefault` to set; if `null` the value defined in the git config will be used. Returns:PushCommand `this` Since 6.1

public PushCommand setPushDefault(PushConfig.PushDefault pushDefault)

Sets an explicit PushDefault. The default used if this is not called is PushDefault#CURRENT for compatibility reasons with earlier JGit versions.

Parameters

pushDefault:PushConfig.PushDefault: PushDefault to set; if null the value defined in the git config will be used.

Returns:PushCommand

this

Since

6.1

setPushOptions back to summary

setPushOptions	back to summary
public PushCommand setPushOptions(List<String> pushOptions) Set the option strings associated with the push operation. Parameters pushOptions:List<String> a `java.util.List` of push option strings Returns:PushCommand `this` Since 4.5

public PushCommand setPushOptions(List<String> pushOptions)

Set the option strings associated with the push operation.

Parameters

pushOptions:List<String>: a java.util.List of push option strings

Returns:PushCommand

this

Since

4.5

setPushTags back to summary

setPushTags	back to summary
public PushCommand setPushTags() Push all tags under refs/tags/*. Returns:PushCommand `this`

public PushCommand setPushTags()

Push all tags under refs/tags/*.

Returns:PushCommand: this

setReceivePack back to summary

setReceivePack	back to summary
public PushCommand setReceivePack(String receivePack) The remote executable providing receive-pack service for pack transports. If no receive-pack is set, the default value of `RemoteConfig.DEFAULT_RECEIVE_PACK` will be used. Parameters receivePack:String name of the remote executable providing the receive-pack service Returns:PushCommand `this` See Also `RemoteConfig#DEFAULT_RECEIVE_PACK`

public PushCommand setReceivePack(String receivePack)

The remote executable providing receive-pack service for pack transports. If no receive-pack is set, the default value of RemoteConfig.DEFAULT_RECEIVE_PACK will be used.

Parameters