|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jgit.submodule.SubmoduleWalk
public class SubmoduleWalk
Walker that visits all submodule entries found in a tree
Constructor Summary | |
---|---|
SubmoduleWalk(Repository repository)
Create submodule generator |
Method Summary | |
---|---|
static SubmoduleWalk |
forIndex(Repository repository)
Create a generator to walk over the submodule entries currently in the index The .gitmodules file is read from the index. |
static SubmoduleWalk |
forPath(Repository repository,
AbstractTreeIterator iterator,
java.lang.String path)
Create a generator and advance it to the submodule entry at the given path |
static SubmoduleWalk |
forPath(Repository repository,
AnyObjectId treeId,
java.lang.String path)
Create a generator and advance it to the submodule entry at the given path |
java.lang.String |
getConfigUpdate()
Get the configured update field for current entry. |
java.lang.String |
getConfigUrl()
Get the configured remote URL for current entry. |
java.io.File |
getDirectory()
Get directory that will be the root of the submodule's local repository |
ObjectId |
getHead()
Get commit id that HEAD points to in the current submodule's repository |
java.lang.String |
getHeadRef()
Get ref that HEAD points to in the current submodule's repository |
java.lang.String |
getModulesPath()
Get the configured path for current entry. |
java.lang.String |
getModulesUpdate()
Get the configured update field for current entry. |
java.lang.String |
getModulesUrl()
Get the configured remote URL for current entry. |
ObjectId |
getObjectId()
Get object id of current submodule entry |
java.lang.String |
getPath()
Get path of current submodule entry |
java.lang.String |
getRemoteUrl()
Get the resolved remote URL for the current submodule. |
Repository |
getRepository()
Get repository for current submodule entry |
static java.io.File |
getSubmoduleDirectory(Repository parent,
java.lang.String path)
Get submodule directory |
static java.lang.String |
getSubmoduleRemoteUrl(Repository parent,
java.lang.String url)
Resolve submodule repository URL. |
static Repository |
getSubmoduleRepository(java.io.File parent,
java.lang.String path)
Get submodule repository at path |
static Repository |
getSubmoduleRepository(Repository parent,
java.lang.String path)
Get submodule repository |
SubmoduleWalk |
loadModulesConfig()
Load the config for this walk from .gitmodules . |
boolean |
next()
Advance to next submodule in the index tree. |
void |
release()
Release any resources used by this walker's reader. |
SubmoduleWalk |
reset()
Reset generator and start new submodule walk |
SubmoduleWalk |
setFilter(TreeFilter filter)
Set tree filter |
SubmoduleWalk |
setModulesConfig(Config config)
Set the config used by this walk. |
SubmoduleWalk |
setRootTree(AbstractTreeIterator tree)
Set the tree used by this walk for finding .gitmodules . |
SubmoduleWalk |
setRootTree(AnyObjectId id)
Set the tree used by this walk for finding .gitmodules . |
SubmoduleWalk |
setTree(AbstractTreeIterator iterator)
Set the tree iterator used for finding submodule entries |
SubmoduleWalk |
setTree(AnyObjectId treeId)
Set the tree used for finding submodule entries |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SubmoduleWalk(Repository repository) throws java.io.IOException
repository
-
java.io.IOException
Method Detail |
---|
public static SubmoduleWalk forIndex(Repository repository) throws java.io.IOException
.gitmodules
file is read from the index.
repository
-
java.io.IOException
public static SubmoduleWalk forPath(Repository repository, AnyObjectId treeId, java.lang.String path) throws java.io.IOException
repository
- treeId
- the root of a tree containing both a submodule at the given path
and .gitmodules at the root.path
-
java.io.IOException
public static SubmoduleWalk forPath(Repository repository, AbstractTreeIterator iterator, java.lang.String path) throws java.io.IOException
repository
- iterator
- the root of a tree containing both a submodule at the given path
and .gitmodules at the root.path
-
java.io.IOException
public static java.io.File getSubmoduleDirectory(Repository parent, java.lang.String path)
parent
- path
-
public static Repository getSubmoduleRepository(Repository parent, java.lang.String path) throws java.io.IOException
parent
- path
-
java.io.IOException
public static Repository getSubmoduleRepository(java.io.File parent, java.lang.String path) throws java.io.IOException
parent
- path
-
java.io.IOException
public static java.lang.String getSubmoduleRemoteUrl(Repository parent, java.lang.String url) throws java.io.IOException
This handles relative URLs that are typically specified in the '.gitmodules' file by resolving them against the remote URL of the parent repository.
Relative URLs will be resolved against the parent repository's working directory if the parent repository has no configured remote URL.
parent
- parent repositoryurl
- absolute or relative URL of the submodule repository
java.io.IOException
public SubmoduleWalk setModulesConfig(Config config)
config
- .gitmodules config object
public SubmoduleWalk setRootTree(AbstractTreeIterator tree)
.gitmodules
.
The root tree is not read until the first submodule is encountered by the walk.
This method need only be called if constructing a walk manually instead of with one of the static factory methods above.
tree
- tree containing .gitmodules
public SubmoduleWalk setRootTree(AnyObjectId id) throws java.io.IOException
.gitmodules
.
The root tree is not read until the first submodule is encountered by the walk.
This method need only be called if constructing a walk manually instead of with one of the static factory methods above.
id
- ID of a tree containing .gitmodules
java.io.IOException
public SubmoduleWalk loadModulesConfig() throws java.io.IOException, ConfigInvalidException
.gitmodules
.
Uses the root tree if setRootTree(AbstractTreeIterator)
was
previously called, otherwise uses the working tree.
If no submodule config is found, loads an empty config.
java.io.IOException
- if an error occurred, or if the repository is bare
ConfigInvalidException
public SubmoduleWalk setFilter(TreeFilter filter)
filter
-
public SubmoduleWalk setTree(AbstractTreeIterator iterator) throws CorruptObjectException
iterator
-
CorruptObjectException
public SubmoduleWalk setTree(AnyObjectId treeId) throws java.io.IOException
treeId
-
java.io.IOException
IncorrectObjectTypeException
MissingObjectException
public SubmoduleWalk reset()
public java.io.File getDirectory()
public boolean next() throws java.io.IOException
getObjectId()
and getPath()
.
java.io.IOException
public java.lang.String getPath()
public ObjectId getObjectId()
public java.lang.String getModulesPath() throws java.io.IOException, ConfigInvalidException
ConfigInvalidException
java.io.IOException
public java.lang.String getConfigUrl() throws java.io.IOException, ConfigInvalidException
ConfigInvalidException
java.io.IOException
public java.lang.String getModulesUrl() throws java.io.IOException, ConfigInvalidException
ConfigInvalidException
java.io.IOException
public java.lang.String getConfigUpdate() throws java.io.IOException, ConfigInvalidException
ConfigInvalidException
java.io.IOException
public java.lang.String getModulesUpdate() throws java.io.IOException, ConfigInvalidException
ConfigInvalidException
java.io.IOException
public Repository getRepository() throws java.io.IOException
java.io.IOException
public ObjectId getHead() throws java.io.IOException
java.io.IOException
public java.lang.String getHeadRef() throws java.io.IOException
java.io.IOException
public java.lang.String getRemoteUrl() throws java.io.IOException, ConfigInvalidException
This method resolves the value of getModulesUrl()
to an absolute
URL
java.io.IOException
ConfigInvalidException
public void release()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |