Modifier and Type	Class and Description
public static class	RepoCommand.DefaultRemoteReader A default implementation of `RemoteReader` callback.
pack-priv static class	RepoCommand.ManifestErrorException
public static class	RepoCommand.RemoteFile Read-only view of contents and file mode (i.e. permissions) for a file in a remote repository.
public static interface	RepoCommand.RemoteReader A callback to get ref sha1 of a repository from its uri.
pack-priv static class	RepoCommand.RemoteUnavailableException

Modifier and Type	Field and Description
private PersonIdent	author
private BareSuperprojectWriter.BareWriterConfig	bareWriterConfig
private String	baseUri
private String	branch
private RepoCommand.RemoteReader	callback
private final List<BareSuperprojectWriter.ExtraContent>	extraContents
private String	groupsParam
private ManifestParser.IncludedFileReader	includedReader
private InputStream	inputStream
private String	manifestPath
private ProgressMonitor	monitor
private static final String	SLASH
private String	targetBranch
private URI	targetUri

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

Method Summary

Modifier and Type	Method and Description
public RepoCommand	Returns: this command addToDestination(String where to create the file in the destination repository path, String content for the create file contents) Create a file with the given content in the destination repository
public RevCommit	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.
pack-priv static URI	relativize(URI current, URI target)
private List<RepoProject>	Returns: projects that are renamed if necessary renameProjects(List<RepoProject> parsed projects projects) Rename the projects if there's a conflict when converted to submodules.
public RepoCommand	Returns: this command setAuthor(PersonIdent the author's `org.eclipse.jgit.lib.PersonIdent` author) Set the author/committer for the bare repository commit.
public RepoCommand	Returns: this command setBranch(String a branch name branch) Set default branch.
public RepoCommand	Returns: this command setGroups(String groups separated by comma, examples: default\|all\|G1,-G2,-G3 groups) Set groups to sync
public RepoCommand	Returns: this command setIgnoreRemoteFailures(boolean Whether to ignore the remote failures. ignore) Set whether to skip projects whose commits don't exist remotely.
public RepoCommand	Returns: this command setIncludedFileReader(ManifestParser.IncludedFileReader a `org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader` object. reader) Set the IncludedFileReader callback.
public RepoCommand	Returns: this command setInputStream(InputStream a `java.io.InputStream` object. inputStream) Set the input stream to the manifest XML.
public RepoCommand	Returns: this command setPath(String (with `/` as separator) path) Set path to the manifest XML file.
public RepoCommand	Returns: this command setProgressMonitor(ProgressMonitor a `org.eclipse.jgit.lib.ProgressMonitor` monitor) The progress monitor associated with the clone operation.
public RepoCommand	Returns: this command setRecommendShallow(boolean Whether to record the shallow recommendation. enable) Set whether the clone-depth field should be recorded as a shallow recommendation in .gitmodules.
public RepoCommand	Returns: this command setRecordRemoteBranch(boolean Whether to record the branch name enable) Set whether the branch name should be recorded in .gitmodules.
public RepoCommand	Returns: this command setRecordSubmoduleLabels(boolean Whether to record the labels in the .gitattributes enable) Set whether the labels field should be recorded as a label in .gitattributes.
public RepoCommand	Returns: this command setRemoteReader(RepoCommand.RemoteReader a `org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader` object. callback) Set the GetHeadFromUri callback.
public RepoCommand	Returns: this command setTargetBranch(String branch name branch) Set target branch.
public RepoCommand	Returns: this command setTargetURI(String the URI of the repository holding the superproject. uri) Set the URI of the superproject (this repository), so the .gitmodules file can specify the submodule URLs relative to the superproject.
public RepoCommand	Returns: this command setURI(String the base URI uri) Set base URI of the paths inside the XML.

Inherited from org.eclipse.jgit.api.GitCommand:: checkCallable getRepository setCallable

Field Detail

author	back to summary
private PersonIdent author

bareWriterConfig	back to summary
private BareSuperprojectWriter.BareWriterConfig bareWriterConfig

baseUri	back to summary
private String baseUri

branch	back to summary
private String branch

callback	back to summary
private RepoCommand.RemoteReader callback

extraContents	back to summary
private final List<BareSuperprojectWriter.ExtraContent> extraContents

groupsParam	back to summary
private String groupsParam

includedReader	back to summary
private ManifestParser.IncludedFileReader includedReader

inputStream	back to summary
private InputStream inputStream

manifestPath	back to summary
private String manifestPath

monitor	back to summary
private ProgressMonitor monitor

SLASH	back to summary
private static final String SLASH

targetBranch	back to summary
private String targetBranch

targetUri	back to summary
private URI targetUri

Constructor Detail

RepoCommand back to summary

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

public RepoCommand(Repository repo)

Constructor for RepoCommand

Parameters

repo:Repository: the org.eclipse.jgit.lib.Repository

Method Detail

addToDestination	back to summary
public RepoCommand addToDestination(String path, String contents) Create a file with the given content in the destination repository Parameters path:String where to create the file in the destination repository contents:String content for the create file Returns:RepoCommand this command Since 6.1

addToDestination

back to summary

public RepoCommand addToDestination(String path, String contents)

Create a file with the given content in the destination repository

Parameters

path:String: where to create the file in the destination repository
contents:String: content for the create file

Returns:RepoCommand

this command

Since

6.1

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

call

back to summary

public RevCommit call() throws GitAPIException

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

Returns:RevCommit

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

computed result

Annotations

@Override

relativize	back to summary
pack-priv static URI relativize(URI current, URI target)

renameProjects	back to summary
private List<RepoProject> renameProjects(List<RepoProject> projects) Rename the projects if there's a conflict when converted to submodules. Parameters projects:List<RepoProject> parsed projects Returns:List<RepoProject> projects that are renamed if necessary

renameProjects

back to summary

private List<RepoProject> renameProjects(List<RepoProject> projects)

Rename the projects if there's a conflict when converted to submodules.

Parameters

projects:List<RepoProject>: parsed projects

Returns:List<RepoProject>

projects that are renamed if necessary

setAuthor back to summary

setAuthor	back to summary
public RepoCommand setAuthor(PersonIdent author) Set the author/committer for the bare repository commit. For non-bare repositories, the current user will be used and this will be ignored. Parameters author:PersonIdent the author's `org.eclipse.jgit.lib.PersonIdent` Returns:RepoCommand this command

public RepoCommand setAuthor(PersonIdent author)

Set the author/committer for the bare repository commit.

For non-bare repositories, the current user will be used and this will be ignored.

Parameters

author:PersonIdent: the author's org.eclipse.jgit.lib.PersonIdent

Returns:RepoCommand

this command

setBranch	back to summary
public RepoCommand setBranch(String branch) Set default branch. This is generally the name of the branch the manifest file was in. If there's no default revision (branch) specified in manifest and no revision specified in project, this branch will be used. Parameters branch:String a branch name Returns:RepoCommand this command

setBranch

back to summary

public RepoCommand setBranch(String branch)

Set default branch.

This is generally the name of the branch the manifest file was in. If there's no default revision (branch) specified in manifest and no revision specified in project, this branch will be used.

Parameters

branch:String: a branch name

Returns:RepoCommand

this command

setGroups	back to summary
public RepoCommand setGroups(String groups) Set groups to sync Parameters groups:String groups separated by comma, examples: default\|all\|G1,-G2,-G3 Returns:RepoCommand this command

setGroups

back to summary

public RepoCommand setGroups(String groups)

Set groups to sync

Parameters

groups:String: groups separated by comma, examples: default|all|G1,-G2,-G3

Returns:RepoCommand

this command

setIgnoreRemoteFailures	back to summary
public RepoCommand setIgnoreRemoteFailures(boolean ignore) Set whether to skip projects whose commits don't exist remotely. When set to true, we'll just skip the manifest entry and continue on to the next one. When set to false (default), we'll throw an error when remote failures occur. Not implemented for non-bare repositories. Parameters ignore:boolean Whether to ignore the remote failures. Returns:RepoCommand this command Since 4.3

setIgnoreRemoteFailures

back to summary

public RepoCommand setIgnoreRemoteFailures(boolean ignore)

Set whether to skip projects whose commits don't exist remotely.

When set to true, we'll just skip the manifest entry and continue on to the next one.

When set to false (default), we'll throw an error when remote failures occur.

Not implemented for non-bare repositories.

Parameters

ignore:boolean: Whether to ignore the remote failures.

Returns:RepoCommand

this command

Since

4.3

setIncludedFileReader back to summary

setIncludedFileReader	back to summary
public RepoCommand setIncludedFileReader(ManifestParser.IncludedFileReader reader) Set the IncludedFileReader callback. Parameters reader:ManifestParser.IncludedFileReader a `org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader` object. Returns:RepoCommand this command Since 4.0

public RepoCommand setIncludedFileReader(ManifestParser.IncludedFileReader reader)

Set the IncludedFileReader callback.

Parameters

reader:ManifestParser.IncludedFileReader: a org.eclipse.jgit.gitrepo.ManifestParser.IncludedFileReader object.

Returns:RepoCommand

this command

Since

4.0

setInputStream back to summary

setInputStream	back to summary
public RepoCommand setInputStream(InputStream inputStream) Set the input stream to the manifest XML. Setting inputStream will ignore the path set. It will be closed in `call`. Parameters inputStream:InputStream a `java.io.InputStream` object. Returns:RepoCommand this command Since 3.5

public RepoCommand setInputStream(InputStream inputStream)

Set the input stream to the manifest XML.

Setting inputStream will ignore the path set. It will be closed in call.

Parameters

inputStream:InputStream: a java.io.InputStream object.

Returns:RepoCommand

this command

Since

3.5

setPath back to summary

setPath	back to summary
public RepoCommand setPath(String path) Set path to the manifest XML file. Calling `setInputStream` will ignore the path set here. Parameters path:String (with `/` as separator) Returns:RepoCommand this command

public RepoCommand setPath(String path)

Set path to the manifest XML file.

Calling setInputStream will ignore the path set here.

Parameters

path:String: (with / as separator)

Returns:RepoCommand

this command

setProgressMonitor back to summary

setProgressMonitor	back to summary
public RepoCommand 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:RepoCommand this command See Also `org.eclipse.jgit.lib.NullProgressMonitor`

public RepoCommand 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:RepoCommand

this command

setRecommendShallow	back to summary
public RepoCommand setRecommendShallow(boolean enable) Set whether the clone-depth field should be recorded as a shallow recommendation in .gitmodules. Not implemented for non-bare repositories. Parameters enable:boolean Whether to record the shallow recommendation. Returns:RepoCommand this command Since 4.4

setRecommendShallow

back to summary

public RepoCommand setRecommendShallow(boolean enable)

Set whether the clone-depth field should be recorded as a shallow recommendation in .gitmodules.

Not implemented for non-bare repositories.

Parameters

enable:boolean: Whether to record the shallow recommendation.

Returns:RepoCommand

this command

Since

4.4

setRecordRemoteBranch	back to summary
public RepoCommand setRecordRemoteBranch(boolean enable) Set whether the branch name should be recorded in .gitmodules. Submodule entries in .gitmodules can include a "branch" field to indicate what remote branch each submodule tracks. That field is used by "git submodule update --remote" to update to the tip of the tracked branch when asked and by Gerrit to update the superproject when a change on that branch is merged. Subprojects that request a specific commit or tag will not have a branch name recorded. Not implemented for non-bare repositories. Parameters enable:boolean Whether to record the branch name Returns:RepoCommand this command Since 4.2

setRecordRemoteBranch

back to summary

public RepoCommand setRecordRemoteBranch(boolean enable)

Set whether the branch name should be recorded in .gitmodules.

Submodule entries in .gitmodules can include a "branch" field to indicate what remote branch each submodule tracks.

That field is used by "git submodule update --remote" to update to the tip of the tracked branch when asked and by Gerrit to update the superproject when a change on that branch is merged.

Subprojects that request a specific commit or tag will not have a branch name recorded.

Not implemented for non-bare repositories.

Parameters

enable:boolean: Whether to record the branch name

Returns:RepoCommand

this command

Since

4.2

setRecordSubmoduleLabels	back to summary
public RepoCommand setRecordSubmoduleLabels(boolean enable) Set whether the labels field should be recorded as a label in .gitattributes. Not implemented for non-bare repositories. Parameters enable:boolean Whether to record the labels in the .gitattributes Returns:RepoCommand this command Since 4.4

setRecordSubmoduleLabels

back to summary

public RepoCommand setRecordSubmoduleLabels(boolean enable)

Set whether the labels field should be recorded as a label in .gitattributes.

Not implemented for non-bare repositories.

Parameters

enable:boolean: Whether to record the labels in the .gitattributes

Returns:RepoCommand

this command

Since

4.4

setRemoteReader back to summary

setRemoteReader	back to summary
public RepoCommand setRemoteReader(RepoCommand.RemoteReader callback) Set the GetHeadFromUri callback. This is only used in bare repositories. Parameters callback:RepoCommand.RemoteReader a `org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader` object. Returns:RepoCommand this command

public RepoCommand setRemoteReader(RepoCommand.RemoteReader callback)

Set the GetHeadFromUri callback. This is only used in bare repositories.

Parameters

callback:RepoCommand.RemoteReader: a org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader object.

Returns:RepoCommand

this command

setTargetBranch	back to summary
public RepoCommand setTargetBranch(String branch) Set target branch. This is the target branch of the super project to be updated. If not set, default is HEAD. For non-bare repositories, HEAD will always be used and this will be ignored. Parameters branch:String branch name Returns:RepoCommand this command Since 4.1

setTargetBranch

back to summary

public RepoCommand setTargetBranch(String branch)

Set target branch.

This is the target branch of the super project to be updated. If not set, default is HEAD.

For non-bare repositories, HEAD will always be used and this will be ignored.

Parameters

branch:String: branch name

Returns:RepoCommand

this command

Since

4.1

setTargetURI	back to summary
public RepoCommand setTargetURI(String uri) Set the URI of the superproject (this repository), so the .gitmodules file can specify the submodule URLs relative to the superproject. Parameters uri:String the URI of the repository holding the superproject. Returns:RepoCommand this command Since 4.8

setTargetURI

back to summary

public RepoCommand setTargetURI(String uri)

Set the URI of the superproject (this repository), so the .gitmodules file can specify the submodule URLs relative to the superproject.

Parameters

uri:String: the URI of the repository holding the superproject.

Returns:RepoCommand

this command

Since

4.8

setURI	back to summary
public RepoCommand setURI(String uri) Set base URI of the paths inside the XML. This is typically the name of the directory holding the manifest repository, eg. for https://android.googlesource.com/platform/manifest, this should be /platform (if you would run this on android.googlesource.com) or https://android.googlesource.com/platform elsewhere. Parameters uri:String the base URI Returns:RepoCommand this command

setURI

back to summary

public RepoCommand setURI(String uri)

Set base URI of the paths inside the XML. This is typically the name of the directory holding the manifest repository, eg. for https://android.googlesource.com/platform/manifest, this should be /platform (if you would run this on android.googlesource.com) or https://android.googlesource.com/platform elsewhere.

Parameters

uri:String: the base URI

Returns:RepoCommand

this command

org.eclipse.jgit.gitrepo back to summary

public Class RepoCommand.DefaultRemoteReader

Class Inheritance

extends Object
implements RemoteReader

java.lang.Object
org.eclipse.jgit.gitrepo.RepoCommand.DefaultRemoteReader

All Implemented Interfaces

org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader

A default implementation of RemoteReader callback.

Constructor Summary

Access	Constructor and Description
public	DefaultRemoteReader()

Method Summary

Modifier and Type	Method and Description
public RepoCommand.RemoteFile	readFileWithMode(String The URI of the remote repository uri, String Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists. ref, String The relative path (inside the repo) to the file to read path) Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode. Read contents and mode (i.e. permissions) of the file from a remote repository.
public ObjectId	sha1(String The URI of the remote repository uri, String Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists. ref) Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1. Read a remote ref sha1.

Modifier and Type

Method and Description

public RepoCommand.RemoteFile

readFileWithMode(String

The URI of the remote repository

uri, String

Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

ref, String

The relative path (inside the repo) to the file to read

path)

Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode.

Read contents and mode (i.e. permissions) of the file from a remote repository.

public ObjectId

sha1(String

The URI of the remote repository

uri, String

Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

ref)

Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1.

Read a remote ref sha1.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

DefaultRemoteReader	back to summary
public DefaultRemoteReader()

Method Detail

readFileWithMode	back to summary
public RepoCommand.RemoteFile readFileWithMode(String uri, String ref, String path) throws GitAPIException, IOException Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode. Doc from org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode. Read contents and mode (i.e. permissions) of the file from a remote repository. Parameters uri:String The URI of the remote repository ref:String Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists. path:String The relative path (inside the repo) to the file to read Returns:RepoCommand.RemoteFile The contents and file mode of the file in the given repository and branch. Never null. Annotations @Override Exceptions GitAPIException: If the ref have an invalid or ambiguous name, or it does not exist in the repository, IOException: If the object does not exist or is too large

readFileWithMode

back to summary

public RepoCommand.RemoteFile readFileWithMode(String uri, String ref, String path) throws GitAPIException, IOException

Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode.

Doc from org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.readFileWithMode.

Read contents and mode (i.e. permissions) of the file from a remote repository.

Parameters

uri:String: The URI of the remote repository
ref:String: Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.
path:String: The relative path (inside the repo) to the file to read

Returns:RepoCommand.RemoteFile

The contents and file mode of the file in the given repository and branch. Never null.

Annotations

@Override

Exceptions

GitAPIException:: If the ref have an invalid or ambiguous name, or it does not exist in the repository,
IOException:: If the object does not exist or is too large

sha1	back to summary
public ObjectId sha1(String uri, String ref) throws GitAPIException Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1. Doc from org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1. Read a remote ref sha1. Parameters uri:String The URI of the remote repository ref:String Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists. Returns:ObjectId the sha1 of the remote repository, or null if the ref does not exist. Annotations @Override Exceptions GitAPIException: a JGit API exception

sha1

back to summary

public ObjectId sha1(String uri, String ref) throws GitAPIException

Implements org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1.

Doc from org.eclipse.jgit.gitrepo.RepoCommand.RemoteReader.sha1.

Read a remote ref sha1.

Parameters

uri:String: The URI of the remote repository
ref:String: Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

Returns:ObjectId

the sha1 of the remote repository, or null if the ref does not exist.

Annotations

@Override

Exceptions

GitAPIException:: a JGit API exception

org.eclipse.jgit.gitrepo back to summary

pack-priv Class RepoCommand.ManifestErrorException

Class Inheritance

extends GitAPIException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.eclipse.jgit.api.errors.GitAPIException
org.eclipse.jgit.gitrepo.RepoCommand.ManifestErrorException

Annotations

@SuppressWarnings:serial

Constructor Summary

Access	Constructor and Description
pack-priv	ManifestErrorException(Throwable cause)

Constructor Detail

ManifestErrorException	back to summary
pack-priv ManifestErrorException(Throwable cause)

org.eclipse.jgit.gitrepo back to summary

public final Class RepoCommand.RemoteFile

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.gitrepo.RepoCommand.RemoteFile

Read-only view of contents and file mode (i.e. permissions) for a file in a remote repository.

Since: 5.2

Field Summary

Modifier and Type	Field and Description
private final byte[]	contents
private final FileMode	fileMode

Constructor Summary

Access	Constructor and Description
public	RemoteFile(byte[] Raw contents of the file. contents, FileMode Git file mode for this file (e.g. executable or regular) fileMode)

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: Raw contents of the file. Do not modify it. getContents() Contents of the file.
public FileMode	Returns: Git file mode for this file (e.g. executable or regular) getFileMode() Get file mode

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

contents	back to summary
private final byte[] contents Annotations @NonNull

fileMode	back to summary
private final FileMode fileMode Annotations @NonNull

Constructor Detail

RemoteFile	back to summary
public RemoteFile(byte[] contents, FileMode fileMode) Parameters contents:byte[] Raw contents of the file. fileMode:FileMode Git file mode for this file (e.g. executable or regular)

Method Detail

getContents

back to summary

public byte[] getContents()

Contents of the file.

Callers who receive this reference must not modify its contents (as it can point to internal cached data).

Returns:byte[]

Raw contents of the file. Do not modify it.

Annotations

@NonNull

getFileMode

back to summary

public FileMode getFileMode()

Get file mode

Returns:FileMode

Git file mode for this file (e.g. executable or regular)

Annotations

@NonNull

org.eclipse.jgit.gitrepo back to summary

public Interface RepoCommand.RemoteReader

Known Direct Implementers: org.eclipse.jgit.gitrepo.RepoCommand.DefaultRemoteReader

A callback to get ref sha1 of a repository from its uri. We provided a default implementation DefaultRemoteReader to use ls-remote command to read the sha1 from the repository and clone the repository to read the file. Callers may have their own quicker implementation.

Since: 3.4

Method Summary

Modifier and Type

Method and Description

public RepoCommand.RemoteFile

Returns:

The contents and file mode of the file in the given repository and branch. Never null.

readFileWithMode(String

The URI of the remote repository

uri, String

Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

ref, String

The relative path (inside the repo) to the file to read

path)

Read contents and mode (i.e. permissions) of the file from a remote repository.

public ObjectId

Returns:

the sha1 of the remote repository, or null if the ref does not exist.

sha1(String

The URI of the remote repository

uri, String

Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

ref)

Read a remote ref sha1.

Method Detail

readFileWithMode

back to summary

public RepoCommand.RemoteFile readFileWithMode(String uri, String ref, String path) throws GitAPIException, IOException

Read contents and mode (i.e. permissions) of the file from a remote repository.

Parameters

uri:String: The URI of the remote repository
ref:String: Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.
path:String: The relative path (inside the repo) to the file to read

Returns:RepoCommand.RemoteFile

The contents and file mode of the file in the given repository and branch. Never null.

Annotations

@NonNull

Exceptions

GitAPIException:: If the ref have an invalid or ambiguous name, or it does not exist in the repository,
IOException:: If the object does not exist or is too large

Since

5.2

sha1

back to summary

public ObjectId sha1(String uri, String ref) throws GitAPIException

Read a remote ref sha1.

Parameters

uri:String: The URI of the remote repository
ref:String: Name of the ref to lookup. May be a short-hand form, e.g. "master" which is automatically expanded to "refs/heads/master" if "refs/heads/master" already exists.

Returns:ObjectId

the sha1 of the remote repository, or null if the ref does not exist.

Annotations

@Nullable

Exceptions

GitAPIException:: a JGit API exception

public Class RepoCommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class RepoCommand.DefaultRemoteReader

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class RepoCommand.ManifestErrorException

Constructor Summary

Constructor Detail

public final Class RepoCommand.RemoteFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface RepoCommand.RemoteReader

Method Summary

Method Detail

pack-priv Class RepoCommand.RemoteUnavailableException

Constructor Summary

Constructor Detail