Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	CloneCommand.Callback Callback for status of clone operation.
private static enum	CloneCommand.FETCH_TYPE

Field Summary

Modifier and Type	Field and Description
private boolean	bare
private String	branch
private Collection<String>	branchesToClone
private CloneCommand.Callback	callback
private boolean	cloneAllBranches
private boolean	cloneSubmodules
private Integer	depth
private File	directory
private boolean	directoryExistsInitially
private CloneCommand.FETCH_TYPE	fetchType
private FS	fs
private File	gitDir
private boolean	gitDirExistsInitially
private boolean	mirror
private ProgressMonitor	monitor
private boolean	noCheckout
private boolean	relativePaths
private String	remote
private List<String>	shallowExcludes
private Instant	shallowSince
private ShutdownHook.Listener	shutdownListener
private TagOpt	tagOption
private String	uri

Inherited from org.eclipse.jgit.api.TransportCommand:: credentialsProvider timeout transportConfigCallback

Constructor Summary

Access	Constructor and Description
public	CloneCommand() Create clone command with no repository set

Method Summary

Modifier and Type	Method and Description
private void	addMergeConfig(Repository clonedRepo, Ref head)
public CloneCommand	Returns: `this` addShallowExclude(String the ref or commit; must not be `null` shallowExclude) Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag.
public CloneCommand	Returns: `this` addShallowExclude(ObjectId the commit; must not be `null` shallowExclude) Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag.
private List<RefSpec>	calculateRefSpecs(CloneCommand.FETCH_TYPE type, String remoteName)
public Git	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	checkout(Repository clonedRepo, FetchResult result)
private void	cleanup()
private void	cloneSubmodules(Repository clonedRepo)
private void	deleteChildren(File file)
private FetchResult	fetch(Repository clonedRepo, URIish u)
private Ref	findBranchToCheckout(FetchResult result)
pack-priv File	Returns: the git directory getDirectory() Get the git directory.
private Repository	init()
private static boolean	isNonEmptyDirectory(File dir)
private RevCommit	parseCommit(Repository clonedRepo, Ref ref)
public CloneCommand	Returns: this instance setBare(boolean whether the cloned repository is bare or not bare) Set whether the cloned repository shall be bare
public CloneCommand	Returns: this instance setBranch(String 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`. branch) Set the initial branch
public CloneCommand	Returns: `this` setBranchesToClone(Collection<String> collection of branches to clone. Must be specified as full ref names (e.g. `refs/heads/master` or `refs/tags/v1.0.0`). branchesToClone) Set the branches or tags to clone.
public CloneCommand	Returns: `this` setCallback(CloneCommand.Callback the callback callback) Register a progress callback.
public CloneCommand	Returns: `this` setCloneAllBranches(boolean `true` when all branches have to be fetched (indicates wildcard in created fetch refspec), `false` otherwise. cloneAllBranches) Set whether all branches have to be fetched.
public CloneCommand	Returns: `this` setCloneSubmodules(boolean true to initialize and update submodules. Ignored when `setBare(boolean)` is set to true. cloneSubmodules) Set whether to clone submodules
public CloneCommand	Returns: `this` setDepth(int the depth depth) Creates a shallow clone with a history truncated to the specified number of commits.
public CloneCommand	Returns: this instance setDirectory(File the directory to clone to, or `null` if the directory name should be taken from the source uri directory) The optional directory associated with the clone operation.
private void	setFetchType()
public CloneCommand	Returns: `this` (for chaining calls). setFs(FS the abstraction. fs) Set the file system abstraction to be used for repositories created by this command.
public CloneCommand	Returns: this instance setGitDir(File the repository meta directory, or `null` to choose one automatically at clone time gitDir) Set the repository meta directory (.git)
public CloneCommand	Returns: `this` setMirror(boolean whether to mirror all refs from the source repository mirror) Set up a mirror of the source repository.
public CloneCommand	Returns: `this` setNoCheckout(boolean 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. noCheckout) Set whether to skip checking out a branch
public CloneCommand	Returns: `this` setNoTags() Set the --no-tags option.
public CloneCommand	Returns: `this` setProgressMonitor(ProgressMonitor a `org.eclipse.jgit.lib.ProgressMonitor` monitor) The progress monitor associated with the clone operation.
public CloneCommand	Returns: this instance setRelativePaths(boolean if true, use relative paths for GIT_DIR and GIT_WORK_TREE relativePaths) Set whether the cloned repository shall use relative paths for GIT_DIR and GIT_WORK_TREE
public CloneCommand	Returns: this instance setRemote(String name that keeps track of the upstream repository. `null` means to use DEFAULT_REMOTE_NAME. remote) The remote name used to keep track of the upstream repository for the clone operation.
public CloneCommand	Returns: `this` setShallowSince(OffsetDateTime the timestammp; must not be `null` shallowSince) Creates a shallow clone with a history after the specified time.
public CloneCommand	Returns: `this` setShallowSince(Instant the timestammp; must not be `null` shallowSince) Creates a shallow clone with a history after the specified time.
public CloneCommand	Returns: `this` setTagOption(TagOpt tag option to be used for the remote config tagOption) Set the tag option used for the remote configuration explicitly.
public CloneCommand	Returns: this instance setURI(String the URI to clone from, or `null` to unset the URI. The URI must be set before `call` is called. uri) Set the URI to clone from
private static void	validateDirs(File directory, File gitDir, boolean bare)
pack-priv void	verifyDirectories(URIish u)

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

Field Detail

bare	back to summary
private boolean bare

branch	back to summary
private String branch

branchesToClone	back to summary
private Collection<String> branchesToClone

callback	back to summary
private CloneCommand.Callback callback

cloneAllBranches	back to summary
private boolean cloneAllBranches

cloneSubmodules	back to summary
private boolean cloneSubmodules

depth	back to summary
private Integer depth

directory	back to summary
private File directory

directoryExistsInitially	back to summary
private boolean directoryExistsInitially

fetchType	back to summary
private CloneCommand.FETCH_TYPE fetchType

fs	back to summary
private FS fs

gitDir	back to summary
private File gitDir

gitDirExistsInitially	back to summary
private boolean gitDirExistsInitially

mirror	back to summary
private boolean mirror

monitor	back to summary
private ProgressMonitor monitor

noCheckout	back to summary
private boolean noCheckout

relativePaths	back to summary
private boolean relativePaths

remote	back to summary
private String remote

shallowExcludes	back to summary
private List<String> shallowExcludes

shallowSince	back to summary
private Instant shallowSince

shutdownListener	back to summary
private ShutdownHook.Listener shutdownListener

tagOption	back to summary
private TagOpt tagOption

uri	back to summary
private String uri

Constructor Detail

CloneCommand	back to summary
public CloneCommand() Create clone command with no repository set

Method Detail

addMergeConfig	back to summary
private void addMergeConfig(Repository clonedRepo, Ref head) throws IOException

addShallowExclude back to summary

addShallowExclude	back to summary
public CloneCommand addShallowExclude(String shallowExclude) Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. Parameters shallowExclude:String the ref or commit; must not be `null` Returns:CloneCommand `this` Since 6.3

public CloneCommand addShallowExclude(String shallowExclude)

Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag.

Parameters

shallowExclude:String: the ref or commit; must not be null

Returns:CloneCommand

this

Since

6.3

addShallowExclude back to summary

addShallowExclude	back to summary
public CloneCommand addShallowExclude(ObjectId shallowExclude) Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. Parameters shallowExclude:ObjectId the commit; must not be `null` Returns:CloneCommand `this` Since 6.3

public CloneCommand addShallowExclude(ObjectId shallowExclude)

Creates a shallow clone with a history, excluding commits reachable from a specified remote branch or tag.

Parameters

shallowExclude:ObjectId: the commit; must not be null

Returns:CloneCommand

this

Since

6.3

calculateRefSpecs	back to summary
private List<RefSpec> calculateRefSpecs(CloneCommand.FETCH_TYPE type, String remoteName)

call back to summary

call	back to summary
public Git 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 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. Returns:Git Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

public Git 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

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.

Returns:Git

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

computed result

Annotations

@Override

checkout	back to summary
private void checkout(Repository clonedRepo, FetchResult result) throws MissingObjectException, IncorrectObjectTypeException, IOException, GitAPIException

cleanup	back to summary
private void cleanup()

cloneSubmodules	back to summary
private void cloneSubmodules(Repository clonedRepo) throws IOException, GitAPIException

deleteChildren	back to summary
private void deleteChildren(File file) throws IOException

fetch	back to summary
private FetchResult fetch(Repository clonedRepo, URIish u) throws URISyntaxException, TransportException, IOException, GitAPIException

findBranchToCheckout	back to summary
private Ref findBranchToCheckout(FetchResult result)

getDirectory	back to summary
pack-priv File getDirectory() Get the git directory. This is primarily used for tests. Returns:File the git directory Annotations @Nullable

getDirectory

back to summary

pack-priv File getDirectory()

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

Returns:File

the git directory

Annotations

@Nullable

init	back to summary
private Repository init() throws GitAPIException

isNonEmptyDirectory	back to summary
private static boolean isNonEmptyDirectory(File dir)

parseCommit	back to summary
private RevCommit parseCommit(Repository clonedRepo, Ref ref) throws MissingObjectException, IncorrectObjectTypeException, IOException

setBare	back to summary
public CloneCommand setBare(boolean bare) throws IllegalStateException Set whether the cloned repository shall be bare Parameters bare:boolean whether the cloned repository is bare or not Returns:CloneCommand this instance Exceptions 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

setBare

back to summary

public CloneCommand setBare(boolean bare) throws IllegalStateException

Set whether the cloned repository shall be bare

Parameters

bare:boolean: whether the cloned repository is bare or not

Returns:CloneCommand

this instance

Exceptions

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

setBranch back to summary

setBranch	back to summary
public CloneCommand setBranch(String branch) Set the initial branch Parameters branch:String 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:CloneCommand this instance

public CloneCommand setBranch(String branch)

Set the initial branch

Parameters

branch:String: 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:CloneCommand

this instance

setBranchesToClone back to summary

setBranchesToClone	back to summary
public CloneCommand setBranchesToClone(Collection<String> branchesToClone) Set the branches or tags to clone. This is ignored if `setCloneAllBranches(true)` or `setMirror(true)` is used. If `branchesToClone` is `null` or empty, it's also ignored. Parameters branchesToClone:Collection<String> collection of branches to clone. Must be specified as full ref names (e.g. `refs/heads/master` or `refs/tags/v1.0.0`). Returns:CloneCommand `this`

public CloneCommand setBranchesToClone(Collection<String> branchesToClone)

Set the branches or tags to clone.

This is ignored if setCloneAllBranches(true) or setMirror(true) is used. If branchesToClone is null or empty, it's also ignored.

Parameters

branchesToClone:Collection<String>: collection of branches to clone. Must be specified as full ref names (e.g. refs/heads/master or refs/tags/v1.0.0).

Returns:CloneCommand

this

setCallback back to summary

setCallback	back to summary
public CloneCommand setCallback(CloneCommand.Callback callback) Register a progress callback. Parameters callback:CloneCommand.Callback the callback Returns:CloneCommand `this` Since 4.8

public CloneCommand setCallback(CloneCommand.Callback callback)

Parameters

callback:CloneCommand.Callback: the callback

Returns:CloneCommand

this

Since

4.8

setCloneAllBranches back to summary

setCloneAllBranches	back to summary
public CloneCommand setCloneAllBranches(boolean cloneAllBranches) Set whether all branches have to be fetched. If `false`, use `setBranchesToClone(Collection)` to define what will be cloned. If neither are set, all branches will be cloned. Parameters cloneAllBranches:boolean `true` when all branches have to be fetched (indicates wildcard in created fetch refspec), `false` otherwise. Returns:CloneCommand `this`

public CloneCommand setCloneAllBranches(boolean cloneAllBranches)

Set whether all branches have to be fetched.

If false, use setBranchesToClone(Collection) to define what will be cloned. If neither are set, all branches will be cloned.

Parameters

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

Returns:CloneCommand

this

setCloneSubmodules back to summary

setCloneSubmodules	back to summary
public CloneCommand setCloneSubmodules(boolean cloneSubmodules) Set whether to clone submodules Parameters cloneSubmodules:boolean true to initialize and update submodules. Ignored when `setBare(boolean)` is set to true. Returns:CloneCommand `this`

public CloneCommand setCloneSubmodules(boolean cloneSubmodules)

Set whether to clone submodules

Parameters

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

Returns:CloneCommand

this

setDepth back to summary

setDepth	back to summary
public CloneCommand setDepth(int depth) Creates a shallow clone with a history truncated to the specified number of commits. Parameters depth:int the depth Returns:CloneCommand `this` Since 6.3

public CloneCommand setDepth(int depth)

Creates a shallow clone with a history truncated to the specified number of commits.

Parameters

depth:int: the depth

Returns:CloneCommand

this

Since

6.3

setDirectory back to summary

public CloneCommand setDirectory(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:File: the directory to clone to, or null if the directory name should be taken from the source uri

Returns:CloneCommand

this instance

Exceptions

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()

setFetchType	back to summary
private void setFetchType()

setFs back to summary

public CloneCommand setFs(FS fs)

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

Parameters

fs:FS: the abstraction.

Returns:CloneCommand

this (for chaining calls).

Since

4.10

setGitDir back to summary

public CloneCommand setGitDir(File gitDir)

Set the repository meta directory (.git)

Parameters

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

Returns:CloneCommand

this instance

Exceptions

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

setMirror back to summary

public CloneCommand setMirror(boolean mirror)

Set up a mirror of the source repository. This implies that a bare repository will be created. Compared to setBare, #setMirror not only maps local branches of the source to local branches of the target, it maps all refs (including remote-tracking branches, notes etc.) and sets up a refspec configuration such that all these refs are overwritten by a git remote update in the target repository.

Parameters

mirror:boolean: whether to mirror all refs from the source repository

Returns:CloneCommand

this

Since

5.6

setNoCheckout back to summary

public CloneCommand setNoCheckout(boolean noCheckout)

Set whether to skip checking out a branch

Parameters

noCheckout:boolean: 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:CloneCommand

this

setNoTags back to summary

public CloneCommand setNoTags()

Set the --no-tags option. Tags are not cloned now and the remote configuration is initialized with the --no-tags option as well.

Returns:CloneCommand: this
Since: 5.8

setProgressMonitor back to summary

public CloneCommand setProgressMonitor(ProgressMonitor monitor)

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

Parameters

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

Returns:CloneCommand

this

See Also

NullProgressMonitor

setRelativePaths

back to summary

public CloneCommand setRelativePaths(boolean relativePaths)

Set whether the cloned repository shall use relative paths for GIT_DIR and GIT_WORK_TREE

Parameters

relativePaths:boolean: if true, use relative paths for GIT_DIR and GIT_WORK_TREE

Returns:CloneCommand

this instance

Since

7.2

setRemote back to summary

public CloneCommand setRemote(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:String: name that keeps track of the upstream repository. null means to use DEFAULT_REMOTE_NAME.

Returns:CloneCommand

this instance

See Also

Constants#DEFAULT_REMOTE_NAME

setShallowSince back to summary

public CloneCommand setShallowSince(OffsetDateTime shallowSince)

Creates a shallow clone with a history after the specified time.

Parameters

shallowSince:OffsetDateTime: the timestammp; must not be null

Returns:CloneCommand

this

Since

6.3

setShallowSince back to summary

public CloneCommand setShallowSince(Instant shallowSince)

Creates a shallow clone with a history after the specified time.

Parameters

shallowSince:Instant: the timestammp; must not be null

Returns:CloneCommand

this

Since

6.3

setTagOption back to summary

public CloneCommand setTagOption(TagOpt tagOption)

Set the tag option used for the remote configuration explicitly.

Parameters

tagOption:TagOpt: tag option to be used for the remote config

Returns:CloneCommand

this

Since

5.8

setURI back to summary

public CloneCommand setURI(String uri)

Set the URI to clone from

Parameters

uri:String: the URI to clone from, or null to unset the URI. The URI must be set before call is called.

Returns:CloneCommand

this instance

validateDirs	back to summary
private static void validateDirs(File directory, File gitDir, boolean bare) throws IllegalStateException

verifyDirectories	back to summary
pack-priv void verifyDirectories(URIish u)

org.eclipse.jgit.api back to summary

public Interface CloneCommand.Callback

Callback for status of clone operation.

Since: 4.8

Method Summary

Modifier and Type	Method and Description
public void	checkingOut(AnyObjectId the id of the commit being checked out commit, String the submodule path path) Notify checkout of commit
public void	cloningSubmodule(String the submodule path path) Notify starting to clone a submodule.
public void	initializedSubmodules(Collection<String> the submodules submodules) Notify initialized submodules.

Method Detail

checkingOut

back to summary

public void checkingOut(AnyObjectId commit, String path)

Notify checkout of commit

Parameters

commit:AnyObjectId: the id of the commit being checked out
path:String: the submodule path

cloningSubmodule

back to summary

public void cloningSubmodule(String path)

Notify starting to clone a submodule.

Parameters

path:String: the submodule path

initializedSubmodules

back to summary

public void initializedSubmodules(Collection<String> submodules)

Notify initialized submodules.

Parameters

submodules:Collection<String>: the submodules

org.eclipse.jgit.api back to summary

private final Enum CloneCommand.FETCH_TYPE

Class Inheritance

extends Enum<CloneCommand.FETCH_TYPE>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.api.CloneCommand.FETCH_TYPE

Field Summary

Modifier and Type	Field and Description
public static final CloneCommand.FETCH_TYPE	ALL_BRANCHES
public static final CloneCommand.FETCH_TYPE	MIRROR
public static final CloneCommand.FETCH_TYPE	MULTIPLE_BRANCHES

Constructor Summary

Access	Constructor and Description
private	FETCH_TYPE()

Method Summary

Modifier and Type	Method and Description
public static CloneCommand.FETCH_TYPE	valueOf(String name)
public static CloneCommand.FETCH_TYPE[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL_BRANCHES	back to summary
public static final CloneCommand.FETCH_TYPE ALL_BRANCHES

MIRROR	back to summary
public static final CloneCommand.FETCH_TYPE MIRROR

MULTIPLE_BRANCHES	back to summary
public static final CloneCommand.FETCH_TYPE MULTIPLE_BRANCHES

Constructor Detail

FETCH_TYPE	back to summary
private FETCH_TYPE()

Method Detail

valueOf	back to summary
public static CloneCommand.FETCH_TYPE valueOf(String name)

values	back to summary
public static CloneCommand.FETCH_TYPE[] values()

public Class CloneCommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface CloneCommand.Callback

Method Summary

Method Detail

private final Enum CloneCommand.FETCH_TYPE

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail