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

Modifier and Type	Field and Description
private ContentMergeStrategy	contentStrategy
private static final String	DOT
private MergeCommand.FastForwardMode	fastForwardMode
private ProgressMonitor	monitor
private BranchConfig.BranchRebaseMode	pullRebaseMode
private String	remote
private String	remoteBranchName
private MergeStrategy	strategy
private SubmoduleConfig.FetchRecurseSubmodulesMode	submoduleRecurseMode
private TagOpt	tagOption

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

Method Summary

Modifier and Type	Method and Description
public PullResult	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 MergeCommand.FastForwardMode	getFastForwardMode()
public static BranchConfig.BranchRebaseMode	Returns: the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` getRebaseMode(String name of the local branch branchName, Config the `org.eclipse.jgit.lib.Config` to read the value from config) Reads the rebase mode to use for a pull command from the repository configuration.
public String	Returns: the remote used for the pull operation if it was set explicitly getRemote() Get the remote name used for pull operation
public String	Returns: the remote branch name used for the pull operation if it was set explicitly getRemoteBranchName() Get the remote branch name for the pull operation
public PullCommand	Returns: `this` setContentMergeStrategy(ContentMergeStrategy the `ContentMergeStrategy` to be used strategy) Sets the content merge strategy to use if the `merge strategy` is "resolve" or "recursive".
public PullCommand	Returns: `this` setFastForward(MergeCommand.FastForwardMode corresponds to the --ff/--no-ff/--ff-only options. If `null` use the value of `pull.ff` configured in git config. If `pull.ff` is not configured fall back to the value of `merge.ff`. If `merge.ff` is not configured --ff is the built-in default. fastForwardMode) Set the fast forward mode.
public PullCommand	Returns: this instance setProgressMonitor(ProgressMonitor a progress monitor monitor) Set progress monitor
public PullCommand	Returns: `this` setRebase(boolean whether to use rebase after fetching useRebase) Set if rebase should be used after fetching.
public PullCommand	Returns: `this` setRebase(BranchConfig.BranchRebaseMode the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` to use rebaseMode) Sets the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` to use after fetching.
public PullCommand	Returns: `this` setRecurseSubmodules(SubmoduleConfig.FetchRecurseSubmodulesMode the `org.eclipse.jgit.lib.SubmoduleConfig.FetchRecurseSubmodulesMode` to be used for recursing into submodules recurse) Set the mode to be used for recursing into submodules.
public PullCommand	Returns: `this` setRemote(String name of the remote to pull from remote) The remote (uri or name) to be used for the pull operation.
public PullCommand	Returns: `this` setRemoteBranchName(String remote branch name to be used for pull operation remoteBranchName) The remote branch name to be used for the pull operation.
public PullCommand	Returns: `this` setStrategy(MergeStrategy The merge strategy to use during this pull operation. strategy) Set the @{code MergeStrategy}
public PullCommand	Returns: `this` setTagOpt(TagOpt the `org.eclipse.jgit.transport.TagOpt` tagOpt) Set the specification of annotated tag behavior during fetch

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

contentStrategy	back to summary
private ContentMergeStrategy contentStrategy

DOT	back to summary
private static final String DOT

fastForwardMode	back to summary
private MergeCommand.FastForwardMode fastForwardMode

monitor	back to summary
private ProgressMonitor monitor

pullRebaseMode	back to summary
private BranchConfig.BranchRebaseMode pullRebaseMode

remote	back to summary
private String remote

remoteBranchName	back to summary
private String remoteBranchName

strategy	back to summary
private MergeStrategy strategy

submoduleRecurseMode	back to summary
private SubmoduleConfig.FetchRecurseSubmodulesMode submoduleRecurseMode

tagOption	back to summary
private TagOpt tagOption

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

Method Detail

call back to summary

call	back to summary
public PullResult call() throws GitAPIException, WrongRepositoryStateException, InvalidConfigurationException, InvalidRemoteException, CanceledException, RefNotFoundException, RefNotAdvertisedException, NoHeadException, 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 `Pull` command with all the options and parameters collected by the setter methods (e.g. `setProgressMonitor(ProgressMonitor)`) of this class. Each instance of this class should only be used for one invocation of the command. Don't call this method twice on an instance. Returns:PullResult Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

public PullResult call() throws GitAPIException, WrongRepositoryStateException, InvalidConfigurationException, InvalidRemoteException, CanceledException, RefNotFoundException, RefNotAdvertisedException, NoHeadException, 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 Pull command with all the options and parameters collected by the setter methods (e.g. setProgressMonitor(ProgressMonitor)) of this class. Each instance of this class should only be used for one invocation of the command. Don't call this method twice on an instance.

Returns:PullResult

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

computed result

Annotations

@Override

getFastForwardMode	back to summary
private MergeCommand.FastForwardMode getFastForwardMode()

getRebaseMode back to summary

getRebaseMode	back to summary
public static BranchConfig.BranchRebaseMode getRebaseMode(String branchName, Config config) Reads the rebase mode to use for a pull command from the repository configuration. This is the value defined for the configurations `branch.[branchName].rebase`, or,if not set, `pull.rebase`. If neither is set, yields `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode#NONE`. Parameters branchName:String name of the local branch config:Config the `org.eclipse.jgit.lib.Config` to read the value from Returns:BranchConfig.BranchRebaseMode the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` Since 4.5

public static BranchConfig.BranchRebaseMode getRebaseMode(String branchName, Config config)

Reads the rebase mode to use for a pull command from the repository configuration. This is the value defined for the configurations branch.[branchName].rebase, or,if not set, pull.rebase. If neither is set, yields org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode#NONE.

Parameters

branchName:String: name of the local branch
config:Config: the org.eclipse.jgit.lib.Config to read the value from

Returns:BranchConfig.BranchRebaseMode

the org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode

Since

4.5

getRemote	back to summary
public String getRemote() Get the remote name used for pull operation Returns:String the remote used for the pull operation if it was set explicitly Since 3.3

getRemote

back to summary

public String getRemote()

Get the remote name used for pull operation

Returns:String: the remote used for the pull operation if it was set explicitly
Since: 3.3

getRemoteBranchName	back to summary
public String getRemoteBranchName() Get the remote branch name for the pull operation Returns:String the remote branch name used for the pull operation if it was set explicitly Since 3.3

getRemoteBranchName

back to summary

public String getRemoteBranchName()

Get the remote branch name for the pull operation

Returns:String: the remote branch name used for the pull operation if it was set explicitly
Since: 3.3

setContentMergeStrategy back to summary

setContentMergeStrategy	back to summary
public PullCommand setContentMergeStrategy(ContentMergeStrategy strategy) Sets the content merge strategy to use if the `merge strategy` is "resolve" or "recursive". Parameters strategy:ContentMergeStrategy the `ContentMergeStrategy` to be used Returns:PullCommand `this` Since 5.12

public PullCommand setContentMergeStrategy(ContentMergeStrategy strategy)

Sets the content merge strategy to use if the merge strategy is "resolve" or "recursive".

Parameters

strategy:ContentMergeStrategy: the ContentMergeStrategy to be used

Returns:PullCommand

this

Since

5.12

setFastForward back to summary

setFastForward	back to summary
public PullCommand setFastForward(MergeCommand.FastForwardMode fastForwardMode) Set the fast forward mode. It is used if pull is configured to do a merge as opposed to rebase. If non-`null` takes precedence over the fast-forward mode configured in git config. Parameters fastForwardMode:MergeCommand.FastForwardMode corresponds to the --ff/--no-ff/--ff-only options. If `null` use the value of `pull.ff` configured in git config. If `pull.ff` is not configured fall back to the value of `merge.ff`. If `merge.ff` is not configured --ff is the built-in default. Returns:PullCommand `this` Since 4.9

public PullCommand setFastForward(MergeCommand.FastForwardMode fastForwardMode)

Set the fast forward mode. It is used if pull is configured to do a merge as opposed to rebase. If non-null takes precedence over the fast-forward mode configured in git config.

Parameters

fastForwardMode:MergeCommand.FastForwardMode: corresponds to the --ff/--no-ff/--ff-only options. If null use the value of pull.ff configured in git config. If pull.ff is not configured fall back to the value of merge.ff. If merge.ff is not configured --ff is the built-in default.

Returns:PullCommand

this

Since

4.9

setProgressMonitor	back to summary
public PullCommand setProgressMonitor(ProgressMonitor monitor) Set progress monitor Parameters monitor:ProgressMonitor a progress monitor Returns:PullCommand this instance

setProgressMonitor

back to summary

public PullCommand setProgressMonitor(ProgressMonitor monitor)

Set progress monitor

Parameters

monitor:ProgressMonitor: a progress monitor

Returns:PullCommand

this instance

setRebase back to summary

setRebase	back to summary
public PullCommand setRebase(boolean useRebase) Set if rebase should be used after fetching. If set to true, rebase is used instead of merge. This is equivalent to --rebase on the command line. If set to false, merge is used after fetching, overriding the configuration file. This is equivalent to --no-rebase on the command line. This setting overrides the settings in the configuration file. By default, the setting in the repository configuration file is used. A branch can be configured to use rebase by default. See branch.[name].rebase and branch.autosetuprebase. Parameters useRebase:boolean whether to use rebase after fetching Returns:PullCommand `this`

public PullCommand setRebase(boolean useRebase)

Set if rebase should be used after fetching. If set to true, rebase is used instead of merge. This is equivalent to --rebase on the command line.

If set to false, merge is used after fetching, overriding the configuration file. This is equivalent to --no-rebase on the command line.

This setting overrides the settings in the configuration file. By default, the setting in the repository configuration file is used.

A branch can be configured to use rebase by default. See branch.[name].rebase and branch.autosetuprebase.

Parameters

useRebase:boolean: whether to use rebase after fetching

Returns:PullCommand

this

setRebase back to summary

setRebase	back to summary
public PullCommand setRebase(BranchConfig.BranchRebaseMode rebaseMode) Sets the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` to use after fetching. BranchRebaseMode.REBASE Equivalent to `--rebase` on the command line: use rebase instead of merge after fetching. BranchRebaseMode.MERGES Equivalent to `--rebase-merges` on the command line: rebase preserving local merge commits. BranchRebaseMode.INTERACTIVE Equivalent to `--interactive` on the command line: use interactive rebase. BranchRebaseMode.NONE Equivalent to `--no-rebase`: merge instead of rebasing. `null` Use the setting defined in the git configuration, either `branch.[name].rebase` or, if not set, `pull.rebase` This setting overrides the settings in the configuration file. By default, the setting in the repository configuration file is used. A branch can be configured to use rebase by default. See `branch.[name].rebase`, `branch.autosetuprebase`, and `pull.rebase`. Parameters rebaseMode:BranchConfig.BranchRebaseMode the `org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode` to use Returns:PullCommand `this` Since 4.5

public PullCommand setRebase(BranchConfig.BranchRebaseMode rebaseMode)

Sets the org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode to use after fetching.

BranchRebaseMode.REBASE: Equivalent to --rebase on the command line: use rebase instead of merge after fetching.
BranchRebaseMode.MERGES: Equivalent to --rebase-merges on the command line: rebase preserving local merge commits.
BranchRebaseMode.INTERACTIVE: Equivalent to --interactive on the command line: use interactive rebase.
BranchRebaseMode.NONE: Equivalent to --no-rebase: merge instead of rebasing.
null: Use the setting defined in the git configuration, either branch.[name].rebase or, if not set, pull.rebase

This setting overrides the settings in the configuration file. By default, the setting in the repository configuration file is used.

A branch can be configured to use rebase by default. See branch.[name].rebase, branch.autosetuprebase, and pull.rebase.

Parameters

rebaseMode:BranchConfig.BranchRebaseMode: the org.eclipse.jgit.lib.BranchConfig.BranchRebaseMode to use

Returns:PullCommand

this

Since

4.5

setRecurseSubmodules back to summary

setRecurseSubmodules	back to summary
public PullCommand setRecurseSubmodules(SubmoduleConfig.FetchRecurseSubmodulesMode recurse) Set the mode to be used for recursing into submodules. Parameters recurse:SubmoduleConfig.FetchRecurseSubmodulesMode the `org.eclipse.jgit.lib.SubmoduleConfig.FetchRecurseSubmodulesMode` to be used for recursing into submodules Returns:PullCommand `this` Since 4.7 See Also `FetchCommand#setRecurseSubmodules(FetchRecurseSubmodulesMode)`

public PullCommand setRecurseSubmodules(SubmoduleConfig.FetchRecurseSubmodulesMode recurse)

Set the mode to be used for recursing into submodules.

Parameters

recurse:SubmoduleConfig.FetchRecurseSubmodulesMode: the org.eclipse.jgit.lib.SubmoduleConfig.FetchRecurseSubmodulesMode to be used for recursing into submodules

Returns:PullCommand

this

Since

4.7

setRemote back to summary

setRemote	back to summary
public PullCommand setRemote(String remote) The remote (uri or name) to be used for the pull operation. If no remote is set, the branch's configuration will be used. If the branch configuration is missing the default value of `Constants.DEFAULT_REMOTE_NAME` will be used. Parameters remote:String name of the remote to pull from Returns:PullCommand `this` Since 3.3 See Also `Constants#DEFAULT_REMOTE_NAME`

public PullCommand setRemote(String remote)

The remote (uri or name) to be used for the pull operation. If no remote is set, the branch's configuration will be used. If the branch configuration is missing the default value of Constants.DEFAULT_REMOTE_NAME will be used.

Parameters

remote:String: name of the remote to pull from

Returns:PullCommand

this

Since

3.3

See Also

Constants#DEFAULT_REMOTE_NAME

setRemoteBranchName back to summary

setRemoteBranchName	back to summary
public PullCommand setRemoteBranchName(String remoteBranchName) The remote branch name to be used for the pull operation. If no remoteBranchName is set, the branch's configuration will be used. If the branch configuration is missing the remote branch with the same name as the current branch is used. Parameters remoteBranchName:String remote branch name to be used for pull operation Returns:PullCommand `this` Since 3.3

public PullCommand setRemoteBranchName(String remoteBranchName)

The remote branch name to be used for the pull operation. If no remoteBranchName is set, the branch's configuration will be used. If the branch configuration is missing the remote branch with the same name as the current branch is used.

Parameters

remoteBranchName:String: remote branch name to be used for pull operation

Returns:PullCommand

this

Since

3.3

setStrategy back to summary

setStrategy	back to summary
public PullCommand setStrategy(MergeStrategy strategy) Set the @{code MergeStrategy} Parameters strategy:MergeStrategy The merge strategy to use during this pull operation. Returns:PullCommand `this` Since 3.4

public PullCommand setStrategy(MergeStrategy strategy)

Set the @{code MergeStrategy}

Parameters

strategy:MergeStrategy: The merge strategy to use during this pull operation.

Returns:PullCommand

this

Since

3.4

setTagOpt back to summary

setTagOpt	back to summary
public PullCommand setTagOpt(TagOpt tagOpt) Set the specification of annotated tag behavior during fetch Parameters tagOpt:TagOpt the `org.eclipse.jgit.transport.TagOpt` Returns:PullCommand `this` Since 4.7

public PullCommand setTagOpt(TagOpt tagOpt)

Set the specification of annotated tag behavior during fetch

Parameters

tagOpt:TagOpt: the org.eclipse.jgit.transport.TagOpt

Returns:PullCommand

this

Since

4.7

public Class PullCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail