org.eclipse.jgit.api

Class CloneCommand

java.lang.Object

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

org.eclipse.jgit.api.TransportCommand<CloneCommand,Git>

org.eclipse.jgit.api.CloneCommand

All Implemented Interfaces:

java.util.concurrent.Callable<Git>

public class CloneCommand
extends TransportCommand<CloneCommand,Git>

Clone a repository into a new working directory

See Also:

Git documentation about Clone

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CloneCommand.Callback Callback for status of clone operation.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bare
private java.lang.String	branch
private java.util.Collection<java.lang.String>	branchesToClone
private CloneCommand.Callback	callback
private boolean	cloneAllBranches
private boolean	cloneSubmodules
private java.io.File	directory
private boolean	directoryExistsInitially
private FS	fs
private java.io.File	gitDir
private boolean	gitDirExistsInitially
private ProgressMonitor	monitor
private boolean	noCheckout
private java.lang.String	remote
private java.lang.String	uri

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
CloneCommand() Create clone command with no repository set

Method Summary

Modifier and Type	Method and Description
private void	addMergeConfig(Repository clonedRepo, Ref head)
private java.util.List<RefSpec>	calculateRefSpecs(java.lang.String dst)
Git	call()
private void	checkout(Repository clonedRepo, FetchResult result)
private void	cleanup()
private void	cloneSubmodules(Repository clonedRepo)
private void	deleteChildren(java.io.File file)
private FetchResult	fetch(Repository clonedRepo, URIish u)
private Ref	findBranchToCheckout(FetchResult result)
(package private) java.io.File	getDirectory() Get the git directory.
private Repository	init()
private static boolean	isNonEmptyDirectory(java.io.File dir)
private RevCommit	parseCommit(Repository clonedRepo, Ref ref)
CloneCommand	setBare(boolean bare) Set whether the cloned repository shall be bare
CloneCommand	setBranch(java.lang.String branch) Set the initial branch
CloneCommand	setBranchesToClone(java.util.Collection<java.lang.String> branchesToClone) Set branches to clone
CloneCommand	setCallback(CloneCommand.Callback callback) Register a progress callback.
CloneCommand	setCloneAllBranches(boolean cloneAllBranches) Set whether all branches have to be fetched
CloneCommand	setCloneSubmodules(boolean cloneSubmodules) Set whether to clone submodules
CloneCommand	setDirectory(java.io.File directory) The optional directory associated with the clone operation.
CloneCommand	setFs(FS fs) Set the file system abstraction to be used for repositories created by this command.
CloneCommand	setGitDir(java.io.File gitDir) Set the repository meta directory (.git)
CloneCommand	setNoCheckout(boolean noCheckout) Set whether to skip checking out a branch
CloneCommand	setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the clone operation.
CloneCommand	setRemote(java.lang.String remote) The remote name used to keep track of the upstream repository for the clone operation.
CloneCommand	setURI(java.lang.String uri) Set the URI to clone from
private static void	validateDirs(java.io.File directory, java.io.File gitDir, boolean bare)
(package private) void	verifyDirectories(URIish u)

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

Field Detail

uri

private java.lang.String uri

directory

private java.io.File directory

gitDir

private java.io.File gitDir

bare

private boolean bare

fs

private FS fs

remote

private java.lang.String remote

branch

private java.lang.String branch

monitor

private ProgressMonitor monitor

cloneAllBranches

private boolean cloneAllBranches

cloneSubmodules

private boolean cloneSubmodules

noCheckout

private boolean noCheckout

branchesToClone

private java.util.Collection<java.lang.String> branchesToClone

callback

private CloneCommand.Callback callback

directoryExistsInitially

private boolean directoryExistsInitially

gitDirExistsInitially

private boolean gitDirExistsInitially

Constructor Detail

CloneCommand

public CloneCommand()

Create clone command with no repository set

Method Detail

getDirectory

@Nullable
java.io.File getDirectory()

Get the git directory. This is primarily used for tests.

Returns:

the git directory

call

public Git call()
         throws GitAPIException,
                InvalidRemoteException,
                TransportException

Execute the command

Executes the Clone command. The Git instance returned by this command needs to be closed by the caller to free resources held by the underlying Repository instance. It is recommended to call this method as soon as you don't need a reference to this Git instance and the underlying Repository instance anymore.

Specified by:

call in interface java.util.concurrent.Callable<Git>

Specified by:

call in class GitCommand<Git>

Throws:

GitAPIException

InvalidRemoteException

TransportException

isNonEmptyDirectory

private static boolean isNonEmptyDirectory(java.io.File dir)

verifyDirectories

void verifyDirectories(URIish u)

init

private Repository init()
                 throws GitAPIException

Throws:

GitAPIException

fetch

private FetchResult fetch(Repository clonedRepo,
                          URIish u)
                   throws java.net.URISyntaxException,
                          TransportException,
                          java.io.IOException,
                          GitAPIException

Throws:

java.net.URISyntaxException

TransportException

java.io.IOException

GitAPIException

calculateRefSpecs

private java.util.List<RefSpec> calculateRefSpecs(java.lang.String dst)

checkout

private void checkout(Repository clonedRepo,
                      FetchResult result)
               throws MissingObjectException,
                      IncorrectObjectTypeException,
                      java.io.IOException,
                      GitAPIException

Throws:

MissingObjectException

IncorrectObjectTypeException

java.io.IOException

GitAPIException

cloneSubmodules

private void cloneSubmodules(Repository clonedRepo)
                      throws java.io.IOException,
                             GitAPIException

Throws:

java.io.IOException

GitAPIException

findBranchToCheckout

private Ref findBranchToCheckout(FetchResult result)

addMergeConfig

private void addMergeConfig(Repository clonedRepo,
                            Ref head)
                     throws java.io.IOException

Throws:

java.io.IOException

parseCommit

private RevCommit parseCommit(Repository clonedRepo,
                              Ref ref)
                       throws MissingObjectException,
                              IncorrectObjectTypeException,
                              java.io.IOException

Throws:

MissingObjectException

IncorrectObjectTypeException

java.io.IOException

setURI

public CloneCommand setURI(java.lang.String uri)

Set the URI to clone from

Parameters:

uri - the URI to clone from, or null to unset the URI. The URI must be set before call() is called.

Returns:

this instance

setDirectory

public CloneCommand setDirectory(java.io.File directory)

The optional directory associated with the clone operation. If the directory isn't set, a name associated with the source uri will be used.

Parameters:

directory - the directory to clone to, or null if the directory name should be taken from the source uri

Returns:

this instance

Throws:

java.lang.IllegalStateException - if the combination of directory, gitDir and bare is illegal. E.g. if for a non-bare repository directory and gitDir point to the same directory of if for a bare repository both directory and gitDir are specified

See Also:

URIish.getHumanishName()

setGitDir

public CloneCommand setGitDir(java.io.File gitDir)

Set the repository meta directory (.git)

Parameters:

gitDir - the repository meta directory, or null to choose one automatically at clone time

Returns:

this instance

Throws:

java.lang.IllegalStateException - if the combination of directory, gitDir and bare is illegal. E.g. if for a non-bare repository directory and gitDir point to the same directory of if for a bare repository both directory and gitDir are specified

Since:

3.6

setBare

public CloneCommand setBare(boolean bare)
                     throws java.lang.IllegalStateException

Set whether the cloned repository shall be bare

Parameters:

bare - whether the cloned repository is bare or not

Returns:

this instance

Throws:

java.lang.IllegalStateException - if the combination of directory, gitDir and bare is illegal. E.g. if for a non-bare repository directory and gitDir point to the same directory of if for a bare repository both directory and gitDir are specified

setFs

public CloneCommand setFs(FS fs)

Set the file system abstraction to be used for repositories created by this command.

Parameters:

fs - the abstraction.

Returns:

this (for chaining calls).

Since:

4.10

setRemote

public CloneCommand setRemote(java.lang.String remote)

The remote name used to keep track of the upstream repository for the clone operation. If no remote name is set, the default value of Constants.DEFAULT_REMOTE_NAME will be used.

Parameters:

remote - name that keeps track of the upstream repository. null means to use DEFAULT_REMOTE_NAME.

Returns:

this instance

See Also:

Constants.DEFAULT_REMOTE_NAME

setBranch

public CloneCommand setBranch(java.lang.String branch)

Set the initial branch

Parameters:

branch - the initial branch to check out when cloning the repository. Can be specified as ref name (refs/heads/master), branch name (master) or tag name (v1.2.3). The default is to use the branch pointed to by the cloned repository's HEAD and can be requested by passing null or HEAD.

Returns:

this instance

setProgressMonitor

public CloneCommand setProgressMonitor(ProgressMonitor monitor)

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

Parameters:

monitor - a ProgressMonitor

Returns:

this

See Also:

NullProgressMonitor

setCloneAllBranches

public CloneCommand setCloneAllBranches(boolean cloneAllBranches)

Set whether all branches have to be fetched

Parameters:

cloneAllBranches - true when all branches have to be fetched (indicates wildcard in created fetch refspec), false otherwise.

Returns:

this

setCloneSubmodules

public CloneCommand setCloneSubmodules(boolean cloneSubmodules)

Set whether to clone submodules

Parameters:

cloneSubmodules - true to initialize and update submodules. Ignored when setBare(boolean) is set to true.

Returns:

this

setBranchesToClone

public CloneCommand setBranchesToClone(java.util.Collection<java.lang.String> branchesToClone)

Set branches to clone

Parameters:

branchesToClone - collection of branches to clone. Ignored when allSelected is true. Must be specified as full ref names (e.g. refs/heads/master).

Returns:

this

setNoCheckout

public CloneCommand setNoCheckout(boolean noCheckout)

Set whether to skip checking out a branch

Parameters:

noCheckout - if set to true no branch will be checked out after the clone. This enhances performance of the clone command when there is no need for a checked out branch.

Returns:

this

setCallback

public CloneCommand setCallback(CloneCommand.Callback callback)

Register a progress callback.

Parameters:

callback - the callback

Returns:

this

Since:

4.8

validateDirs

private static void validateDirs(java.io.File directory,
                                 java.io.File gitDir,
                                 boolean bare)
                          throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

cleanup

private void cleanup()

deleteChildren

private void deleteChildren(java.io.File file)
                     throws java.io.IOException

Throws:

java.io.IOException