org.eclipse.jgit.api

Class SubmoduleUpdateCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<T>

org.eclipse.jgit.api.TransportCommand<SubmoduleUpdateCommand,Collection<String>>

org.eclipse.jgit.api.SubmoduleUpdateCommand

All Implemented Interfaces:

Callable<Collection<String>>

public class SubmoduleUpdateCommand
extends TransportCommand<SubmoduleUpdateCommand,Collection<String>>

A class used to execute a submodule update command.

See Also:

Git documentation about submodules

Field Summary

Fields inherited from class org.eclipse.jgit.api.TransportCommand

credentialsProvider, timeout, transportConfigCallback

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Constructor and Description
SubmoduleUpdateCommand(Repository repo) Constructor for SubmoduleUpdateCommand.

Method Summary

Modifier and Type	Method and Description
SubmoduleUpdateCommand	addPath(String path) Add repository-relative submodule path to initialize
Collection<String>	call() Execute the SubmoduleUpdateCommand command.
SubmoduleUpdateCommand	setCallback(CloneCommand.Callback callback) Set status callback for submodule clone operation.
SubmoduleUpdateCommand	setFetch(boolean fetch) Whether to fetch the submodules before we update them.
SubmoduleUpdateCommand	setFetchCallback(FetchCommand.Callback callback) Set status callback for submodule fetch operation.
SubmoduleUpdateCommand	setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the clone operation.
SubmoduleUpdateCommand	setStrategy(MergeStrategy strategy) Setter for the field strategy.

Methods inherited from class org.eclipse.jgit.api.TransportCommand

configure, configure, self, setCredentialsProvider, setTimeout, setTransportConfigCallback

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubmoduleUpdateCommand

public SubmoduleUpdateCommand(Repository repo)

Constructor for SubmoduleUpdateCommand.

Parameters:

repo - a Repository object.

Method Detail

setProgressMonitor

public SubmoduleUpdateCommand setProgressMonitor(ProgressMonitor monitor)

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

Parameters:

monitor - a ProgressMonitor object.

Returns:

this command

See Also:

NullProgressMonitor

setFetch

public SubmoduleUpdateCommand setFetch(boolean fetch)

Whether to fetch the submodules before we update them. By default, this is set to false

Parameters:

fetch - whether to fetch the submodules before we update them

Returns:

this command

Since:

4.9

addPath

public SubmoduleUpdateCommand addPath(String path)

Add repository-relative submodule path to initialize

Parameters:

path - (with / as separator)

Returns:

this command

call

public Collection<String> call()
                        throws InvalidConfigurationException,
                               NoHeadException,
                               ConcurrentRefUpdateException,
                               CheckoutConflictException,
                               InvalidMergeHeadsException,
                               WrongRepositoryStateException,
                               NoMessageException,
                               NoHeadException,
                               RefNotFoundException,
                               GitAPIException

Execute the command Execute the SubmoduleUpdateCommand command.

Specified by:

call in interface Callable<Collection<String>>

Specified by:

call in class GitCommand<Collection<String>>

Throws:

InvalidConfigurationException

NoHeadException

ConcurrentRefUpdateException

CheckoutConflictException

InvalidMergeHeadsException

WrongRepositoryStateException

NoMessageException

RefNotFoundException

GitAPIException

setStrategy

public SubmoduleUpdateCommand setStrategy(MergeStrategy strategy)

Setter for the field strategy.

Parameters:

strategy - The merge strategy to use during this update operation.

Returns:

this

Since:

3.4

setCallback

public SubmoduleUpdateCommand setCallback(CloneCommand.Callback callback)

Set status callback for submodule clone operation.

Parameters:

callback - the callback

Returns:

this

Since:

4.8

setFetchCallback

public SubmoduleUpdateCommand setFetchCallback(FetchCommand.Callback callback)

Set status callback for submodule fetch operation.

Parameters:

callback - the callback

Returns:

this

Since:

4.9