JGit 7.2.0.202503040940-r · org.eclipse.jgit.submodule.SubmoduleWalk

Modifier and Type	Class and Description
public static enum	SubmoduleWalk.IgnoreSubmoduleMode The values for the config parameter submodule.

Modifier and Type	Field and Description
private RepositoryBuilderFactory	factory
private Config	modulesConfig
private String	path
private Map<String, String>	pathToName
private StoredConfig	repoConfig
private final Repository	repository
private AbstractTreeIterator	rootTree
private final TreeWalk	walk

Access	Constructor and Description
public	SubmoduleWalk(Repository the `org.eclipse.jgit.lib.Repository`. repository) Create submodule generator

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public static boolean	Returns: `true` if the working tree contains a .gitmodules file, `false` otherwise. Always returns `false` for bare repositories. containsGitModulesFile(Repository the repository to check repository) Checks whether the working tree contains a .gitmodules file.
public static SubmoduleWalk	Returns: generator over submodule index entries. The caller is responsible for calling `close()`. forIndex(Repository a `org.eclipse.jgit.lib.Repository` object. repository) Create a generator to walk over the submodule entries currently in the index The `.gitmodules` file is read from the index.
public static SubmoduleWalk	Returns: generator at given path. The caller is responsible for calling `close()`. Null if no submodule at given path. forPath(Repository a `org.eclipse.jgit.lib.Repository` object. repository, AnyObjectId the root of a tree containing both a submodule at the given path and .gitmodules at the root. treeId, String a `java.lang.String` object. path) Create a generator and advance it to the submodule entry at the given path
public static SubmoduleWalk	Returns: generator at given path. The caller is responsible for calling `close()`. Null if no submodule at given path. forPath(Repository a `org.eclipse.jgit.lib.Repository` object. repository, AbstractTreeIterator the root of a tree containing both a submodule at the given path and .gitmodules at the root. iterator, String a `java.lang.String` object. path) Create a generator and advance it to the submodule entry at the given path
private BaseRepositoryBuilder<?, ? extends Repository>	getBuilder()
public String	Returns: update value getConfigUpdate() Get the configured update field for current entry.
public String	Returns: configured URL getConfigUrl() Get the configured remote URL for current entry.
public File	Returns: submodule repository directory getDirectory() Get directory that will be the root of the submodule's local repository
public ObjectId	Returns: object id of HEAD reference getHead() Get commit id that HEAD points to in the current submodule's repository
public String	Returns: ref name, null on failures getHeadRef() Get ref that HEAD points to in the current submodule's repository
private String	getModuleName(String modulePath)
public String	Returns: name of the submodule getModuleName() The module name for the current submodule entry (used for the section name of .git/config)
public SubmoduleWalk.IgnoreSubmoduleMode	Returns: ignore value getModulesIgnore() Get the configured ignore field for the current entry.
public String	Returns: configured path getModulesPath() Get the configured path for current entry.
public String	Returns: update value getModulesUpdate() Get the configured update field for current entry.
public String	Returns: configured URL getModulesUrl() Get the configured remote URL for current entry.
public ObjectId	Returns: object id getObjectId() Get object id of current submodule entry
public String	Returns: path getPath() Get path of current submodule entry
public String	Returns: resolved remote URL getRemoteUrl() Get the resolved remote URL for the current submodule.
public Repository	Returns: repository or null if non-existent getRepository() Get repository for current submodule entry
public static File	Returns: directory getSubmoduleDirectory(final Repository the `org.eclipse.jgit.lib.Repository`. parent, final String submodule path path) Get submodule directory
public static String	Returns: resolved URL getSubmoduleRemoteUrl(final Repository parent repository parent, final String absolute or relative URL of the submodule repository url) Resolve submodule repository URL.
public static Repository	Returns: repository or null if repository doesn't exist getSubmoduleRepository(final Repository the `org.eclipse.jgit.lib.Repository`. parent, final String submodule path path) Get submodule repository
public static Repository	Returns: repository or null if repository doesn't exist getSubmoduleRepository(final File the parent parent, final String submodule path path) Get submodule repository at path
public static Repository	Returns: repository or null if repository doesn't exist getSubmoduleRepository(final File `Repository` that contains the submodule parent, final String of the working tree of the submodule path, FS the file system abstraction to be used fs) Get submodule repository at path, using the specified file system abstraction
public static Repository	Returns: the `Repository` of the submodule, or `null` if it doesn't exist getSubmoduleRepository(File `Repository` that contains the submodule parent, String of the working tree of the submodule path, FS `FS` to use fs, BaseRepositoryBuilder<?, ? extends Repository> `BaseRepositoryBuilder` to use to build the submodule repository builder) Get submodule repository at path, using the specified file system abstraction and the specified builder
private void	lazyLoadModulesConfig()
public SubmoduleWalk	Returns: this generator loadModulesConfig() Load the config for this walk from `.gitmodules`.
private void	loadPathNames()
public boolean	Returns: true if entry found, false otherwise next() Advance to next submodule in the index tree.
public SubmoduleWalk	Returns: this generator reset() Reset generator and start new submodule walk
public void	setBuilderFactory(RepositoryBuilderFactory to set factory) Sets the `RepositoryBuilderFactory` to use for creating submodule repositories.
public SubmoduleWalk	Returns: this generator setFilter(TreeFilter a `org.eclipse.jgit.treewalk.filter.TreeFilter` object. filter) Set tree filter
public SubmoduleWalk	Returns: this generator setModulesConfig(Config .gitmodules config object config) Set the config used by this walk.
public SubmoduleWalk	Returns: this generator setRootTree(AbstractTreeIterator tree containing .gitmodules tree) Set the tree used by this walk for finding `.gitmodules`.
public SubmoduleWalk	Returns: this generator setRootTree(AnyObjectId ID of a tree containing .gitmodules id) Set the tree used by this walk for finding `.gitmodules`.
public SubmoduleWalk	Returns: this generator setTree(AbstractTreeIterator an `org.eclipse.jgit.treewalk.AbstractTreeIterator` object. iterator) Set the tree iterator used for finding submodule entries
public SubmoduleWalk	Returns: this generator setTree(AnyObjectId an `org.eclipse.jgit.lib.AnyObjectId` object. treeId) Set the tree used for finding submodule entries

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

factory	back to summary
private RepositoryBuilderFactory factory

modulesConfig	back to summary
private Config modulesConfig

path	back to summary
private String path

pathToName	back to summary
private Map<String, String> pathToName

repoConfig	back to summary
private StoredConfig repoConfig

repository	back to summary
private final Repository repository

rootTree	back to summary
private AbstractTreeIterator rootTree

walk	back to summary
private final TreeWalk walk

SubmoduleWalk	back to summary
public SubmoduleWalk(Repository repository) throws IOException Create submodule generator Parameters repository:Repository the `org.eclipse.jgit.lib.Repository`. Exceptions IOException: if an IO error occurred

Method Detail

close back to summary

close	back to summary
public void close() Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Release any resources used by this walker's reader. Annotations @Override Since 4.0

public void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Release any resources used by this walker's reader.

Annotations

@Override

Since

4.0

containsGitModulesFile back to summary

containsGitModulesFile	back to summary
public static boolean containsGitModulesFile(Repository repository) throws IOException Checks whether the working tree contains a .gitmodules file. That's a hint that the repo contains submodules. Parameters repository:Repository the repository to check Returns:boolean `true` if the working tree contains a .gitmodules file, `false` otherwise. Always returns `false` for bare repositories. Exceptions IOException: if an IO error occurred CorruptObjectException: if a corrupt object was found Since 3.6

public static boolean containsGitModulesFile(Repository repository) throws IOException

Checks whether the working tree contains a .gitmodules file. That's a hint that the repo contains submodules.

Parameters

repository:Repository: the repository to check

Returns:boolean

true if the working tree contains a .gitmodules file, false otherwise. Always returns false for bare repositories.

Exceptions

IOException:: if an IO error occurred
CorruptObjectException:: if a corrupt object was found

Since

3.6

forIndex back to summary

forIndex	back to summary
public static SubmoduleWalk forIndex(Repository repository) throws IOException Create a generator to walk over the submodule entries currently in the index The `.gitmodules` file is read from the index. Parameters repository:Repository a `org.eclipse.jgit.lib.Repository` object. Returns:SubmoduleWalk generator over submodule index entries. The caller is responsible for calling `close()`. Exceptions IOException: if an IO error occurred

public static SubmoduleWalk forIndex(Repository repository) throws IOException

Create a generator to walk over the submodule entries currently in the index The .gitmodules file is read from the index.

Parameters

repository:Repository: a org.eclipse.jgit.lib.Repository object.

Returns:SubmoduleWalk

generator over submodule index entries. The caller is responsible for calling close().

Exceptions

IOException:: if an IO error occurred

forPath back to summary

forPath	back to summary
public static SubmoduleWalk forPath(Repository repository, AnyObjectId treeId, String path) throws IOException Create a generator and advance it to the submodule entry at the given path Parameters repository:Repository a `org.eclipse.jgit.lib.Repository` object. treeId:AnyObjectId the root of a tree containing both a submodule at the given path and .gitmodules at the root. path:String a `java.lang.String` object. Returns:SubmoduleWalk generator at given path. The caller is responsible for calling `close()`. Null if no submodule at given path. Exceptions IOException: if an IO error occurred

public static SubmoduleWalk forPath(Repository repository, AnyObjectId treeId, String path) throws IOException

Create a generator and advance it to the submodule entry at the given path

Parameters

repository:Repository: a org.eclipse.jgit.lib.Repository object.
treeId:AnyObjectId: the root of a tree containing both a submodule at the given path and .gitmodules at the root.
path:String: a java.lang.String object.

Returns:SubmoduleWalk

generator at given path. The caller is responsible for calling close(). Null if no submodule at given path.

Exceptions

IOException:: if an IO error occurred

forPath back to summary

forPath	back to summary
public static SubmoduleWalk forPath(Repository repository, AbstractTreeIterator iterator, String path) throws IOException Create a generator and advance it to the submodule entry at the given path Parameters repository:Repository a `org.eclipse.jgit.lib.Repository` object. iterator:AbstractTreeIterator the root of a tree containing both a submodule at the given path and .gitmodules at the root. path:String a `java.lang.String` object. Returns:SubmoduleWalk generator at given path. The caller is responsible for calling `close()`. Null if no submodule at given path. Exceptions IOException: if an IO error occurred

public static SubmoduleWalk forPath(Repository repository, AbstractTreeIterator iterator, String path) throws IOException

Create a generator and advance it to the submodule entry at the given path

Parameters

repository:Repository: a org.eclipse.jgit.lib.Repository object.
iterator:AbstractTreeIterator: the root of a tree containing both a submodule at the given path and .gitmodules at the root.
path:String: a java.lang.String object.

Returns:SubmoduleWalk

generator at given path. The caller is responsible for calling close(). Null if no submodule at given path.

Exceptions

IOException:: if an IO error occurred

getBuilder	back to summary
private BaseRepositoryBuilder<?, ? extends Repository> getBuilder()

getConfigUpdate	back to summary
public String getConfigUpdate() throws IOException, ConfigInvalidException Get the configured update field for current entry. This will be the value from the repository's config. Returns:String update value Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

getConfigUpdate

back to summary

public String getConfigUpdate() throws IOException, ConfigInvalidException

Get the configured update field for current entry. This will be the value from the repository's config.

Returns:String

update value

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getConfigUrl	back to summary
public String getConfigUrl() throws IOException, ConfigInvalidException Get the configured remote URL for current entry. This will be the value from the repository's config. Returns:String configured URL Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

getConfigUrl

back to summary

public String getConfigUrl() throws IOException, ConfigInvalidException

Get the configured remote URL for current entry. This will be the value from the repository's config.

Returns:String

configured URL

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getDirectory	back to summary
public File getDirectory() Get directory that will be the root of the submodule's local repository Returns:File submodule repository directory

getDirectory

back to summary

public File getDirectory()

Get directory that will be the root of the submodule's local repository

Returns:File: submodule repository directory

getHead	back to summary
public ObjectId getHead() throws IOException Get commit id that HEAD points to in the current submodule's repository Returns:ObjectId object id of HEAD reference Exceptions IOException: if an IO error occurred

getHead

back to summary

public ObjectId getHead() throws IOException

Get commit id that HEAD points to in the current submodule's repository

Returns:ObjectId

object id of HEAD reference

Exceptions

IOException:: if an IO error occurred

getHeadRef	back to summary
public String getHeadRef() throws IOException Get ref that HEAD points to in the current submodule's repository Returns:String ref name, null on failures Exceptions IOException: if an IO error occurred

getHeadRef

back to summary

public String getHeadRef() throws IOException

Get ref that HEAD points to in the current submodule's repository

Returns:String

ref name, null on failures

Exceptions

IOException:: if an IO error occurred

getModuleName	back to summary
private String getModuleName(String modulePath)

getModuleName	back to summary
public String getModuleName() throws IOException, ConfigInvalidException The module name for the current submodule entry (used for the section name of .git/config) Returns:String name of the submodule Exceptions IOException: if an IO error occurred ConfigInvalidException: if the .gitmodules config is invalid Since 4.10

getModuleName

back to summary

public String getModuleName() throws IOException, ConfigInvalidException

The module name for the current submodule entry (used for the section name of .git/config)

Returns:String

name of the submodule

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if the .gitmodules config is invalid

Since

4.10

getModulesIgnore	back to summary
public SubmoduleWalk.IgnoreSubmoduleMode getModulesIgnore() throws IOException, ConfigInvalidException Get the configured ignore field for the current entry. This will be the value from the .gitmodules file in the current repository's working tree. Returns:SubmoduleWalk.IgnoreSubmoduleMode ignore value Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid Since 3.6

getModulesIgnore

back to summary

public SubmoduleWalk.IgnoreSubmoduleMode getModulesIgnore() throws IOException, ConfigInvalidException

Get the configured ignore field for the current entry. This will be the value from the .gitmodules file in the current repository's working tree.

Returns:SubmoduleWalk.IgnoreSubmoduleMode

ignore value

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

Since

3.6

getModulesPath	back to summary
public String getModulesPath() throws IOException, ConfigInvalidException Get the configured path for current entry. This will be the value from the .gitmodules file in the current repository's working tree. Returns:String configured path Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

getModulesPath

back to summary

public String getModulesPath() throws IOException, ConfigInvalidException

Get the configured path for current entry. This will be the value from the .gitmodules file in the current repository's working tree.

Returns:String

configured path

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getModulesUpdate	back to summary
public String getModulesUpdate() throws IOException, ConfigInvalidException Get the configured update field for current entry. This will be the value from the .gitmodules file in the current repository's working tree. Returns:String update value Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

getModulesUpdate

back to summary

public String getModulesUpdate() throws IOException, ConfigInvalidException

Get the configured update field for current entry. This will be the value from the .gitmodules file in the current repository's working tree.

Returns:String

update value

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getModulesUrl	back to summary
public String getModulesUrl() throws IOException, ConfigInvalidException Get the configured remote URL for current entry. This will be the value from the .gitmodules file in the current repository's working tree. Returns:String configured URL Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

getModulesUrl

back to summary

public String getModulesUrl() throws IOException, ConfigInvalidException

Get the configured remote URL for current entry. This will be the value from the .gitmodules file in the current repository's working tree.

Returns:String

configured URL

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getObjectId	back to summary
public ObjectId getObjectId() Get object id of current submodule entry Returns:ObjectId object id

getObjectId

back to summary

public ObjectId getObjectId()

Get object id of current submodule entry

Returns:ObjectId: object id

getPath	back to summary
public String getPath() Get path of current submodule entry Returns:String path

getPath

back to summary

public String getPath()

Get path of current submodule entry

Returns:String: path

getRemoteUrl back to summary

getRemoteUrl	back to summary
public String getRemoteUrl() throws IOException, ConfigInvalidException Get the resolved remote URL for the current submodule. This method resolves the value of `getModulesUrl()` to an absolute URL Returns:String resolved remote URL Exceptions IOException: if an IO error occurred ConfigInvalidException: if .gitmodules config is invalid

public String getRemoteUrl() throws IOException, ConfigInvalidException

Get the resolved remote URL for the current submodule.

This method resolves the value of getModulesUrl() to an absolute URL

Returns:String

resolved remote URL

Exceptions

IOException:: if an IO error occurred
ConfigInvalidException:: if .gitmodules config is invalid

getRepository	back to summary
public Repository getRepository() throws IOException Get repository for current submodule entry Returns:Repository repository or null if non-existent Exceptions IOException: if an IO error occurred

getRepository

back to summary

public Repository getRepository() throws IOException

Get repository for current submodule entry

Returns:Repository

repository or null if non-existent

Exceptions

IOException:: if an IO error occurred

getSubmoduleDirectory back to summary

getSubmoduleDirectory	back to summary
public static File getSubmoduleDirectory(final Repository parent, final String path) Get submodule directory Parameters parent:Repository the `org.eclipse.jgit.lib.Repository`. path:String submodule path Returns:File directory

public static File getSubmoduleDirectory(final Repository parent, final String path)

Get submodule directory

Parameters

parent:Repository: the org.eclipse.jgit.lib.Repository.
path:String: submodule path

Returns:File

directory

getSubmoduleRemoteUrl	back to summary
public static String getSubmoduleRemoteUrl(final Repository parent, final String url) throws IOException Resolve submodule repository URL. 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. Parameters parent:Repository parent repository url:String absolute or relative URL of the submodule repository Returns:String resolved URL Exceptions IOException: if an IO error occurred

getSubmoduleRemoteUrl

back to summary

public static String getSubmoduleRemoteUrl(final Repository parent, final String url) throws IOException

Resolve submodule repository URL.

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.

Parameters

parent:Repository: parent repository
url:String: absolute or relative URL of the submodule repository

Returns:String

resolved URL

Exceptions

IOException:: if an IO error occurred

getSubmoduleRepository back to summary

getSubmoduleRepository	back to summary
public static Repository getSubmoduleRepository(final Repository parent, final String path) throws IOException Get submodule repository Parameters parent:Repository the `org.eclipse.jgit.lib.Repository`. path:String submodule path Returns:Repository repository or null if repository doesn't exist Exceptions IOException: if an IO error occurred

public static Repository getSubmoduleRepository(final Repository parent, final String path) throws IOException

Get submodule repository

Parameters

parent:Repository: the org.eclipse.jgit.lib.Repository.
path:String: submodule path

Returns:Repository

repository or null if repository doesn't exist

Exceptions

IOException:: if an IO error occurred

getSubmoduleRepository	back to summary
public static Repository getSubmoduleRepository(final File parent, final String path) throws IOException Get submodule repository at path Parameters parent:File the parent path:String submodule path Returns:Repository repository or null if repository doesn't exist Exceptions IOException: if an IO error occurred

getSubmoduleRepository

back to summary

public static Repository getSubmoduleRepository(final File parent, final String path) throws IOException

Get submodule repository at path

Parameters

parent:File: the parent
path:String: submodule path

Returns:Repository

repository or null if repository doesn't exist

Exceptions

IOException:: if an IO error occurred

getSubmoduleRepository back to summary

getSubmoduleRepository	back to summary
public static Repository getSubmoduleRepository(final File parent, final String path, FS fs) throws IOException Get submodule repository at path, using the specified file system abstraction Parameters parent:File `Repository` that contains the submodule path:String of the working tree of the submodule fs:FS the file system abstraction to be used Returns:Repository repository or null if repository doesn't exist Exceptions IOException: if an IO error occurred Since 4.10

public static Repository getSubmoduleRepository(final File parent, final String path, FS fs) throws IOException

Get submodule repository at path, using the specified file system abstraction

Parameters

parent:File: Repository that contains the submodule
path:String: of the working tree of the submodule
fs:FS: the file system abstraction to be used

Returns:Repository

repository or null if repository doesn't exist

Exceptions

IOException:: if an IO error occurred

Since

4.10

getSubmoduleRepository back to summary

getSubmoduleRepository	back to summary
public static Repository getSubmoduleRepository(File parent, String path, FS fs, BaseRepositoryBuilder<?, ? extends Repository> builder) throws IOException Get submodule repository at path, using the specified file system abstraction and the specified builder Parameters parent:File `Repository` that contains the submodule path:String of the working tree of the submodule fs:FS `FS` to use builder:BaseRepositoryBuilder<?, ? extends Repository> `BaseRepositoryBuilder` to use to build the submodule repository Returns:Repository the `Repository` of the submodule, or `null` if it doesn't exist Exceptions IOException: if an IO error occurred Since 5.6

public static Repository getSubmoduleRepository(File parent, String path, FS fs, BaseRepositoryBuilder<?, ? extends Repository> builder) throws IOException

Get submodule repository at path, using the specified file system abstraction and the specified builder

Parameters

parent:File: Repository that contains the submodule
path:String: of the working tree of the submodule
fs:FS: FS to use
builder:BaseRepositoryBuilder<?, ? extends Repository>: BaseRepositoryBuilder to use to build the submodule repository

Returns:Repository

the Repository of the submodule, or null if it doesn't exist

Exceptions

IOException:: if an IO error occurred

Since

5.6

lazyLoadModulesConfig	back to summary
private void lazyLoadModulesConfig() throws IOException, ConfigInvalidException

loadModulesConfig back to summary

loadModulesConfig	back to summary
public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidException Load the config for this walk from `.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. Returns:SubmoduleWalk this generator Exceptions IOException: if an error occurred, or if the repository is bare ConfigInvalidException: if .gitmodules config is invalid

public SubmoduleWalk loadModulesConfig() throws IOException, ConfigInvalidException

Load the config for this walk from .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.

Returns:SubmoduleWalk

this generator

Exceptions

IOException:: if an error occurred, or if the repository is bare
ConfigInvalidException:: if .gitmodules config is invalid

loadPathNames	back to summary
private void loadPathNames()

next back to summary

next	back to summary
public boolean next() throws IOException Advance to next submodule in the index tree. The object id and path of the next entry can be obtained by calling `getObjectId()` and `getPath()`. Returns:boolean true if entry found, false otherwise Exceptions IOException: if an IO error occurred

public boolean next() throws IOException

Advance to next submodule in the index tree. The object id and path of the next entry can be obtained by calling getObjectId() and getPath().

Returns:boolean

true if entry found, false otherwise

Exceptions

IOException:: if an IO error occurred

reset	back to summary
public SubmoduleWalk reset() Reset generator and start new submodule walk Returns:SubmoduleWalk this generator

reset

back to summary

public SubmoduleWalk reset()

Reset generator and start new submodule walk

Returns:SubmoduleWalk: this generator

setBuilderFactory back to summary

setBuilderFactory	back to summary
public void setBuilderFactory(RepositoryBuilderFactory factory) Sets the `RepositoryBuilderFactory` to use for creating submodule repositories. If none is set, a plain `RepositoryBuilder` is used. Parameters factory:RepositoryBuilderFactory to set Since 5.6

public void setBuilderFactory(RepositoryBuilderFactory factory)

Sets the RepositoryBuilderFactory to use for creating submodule repositories. If none is set, a plain RepositoryBuilder is used.

Parameters

factory:RepositoryBuilderFactory: to set

Since

5.6

setFilter back to summary

setFilter	back to summary
public SubmoduleWalk setFilter(TreeFilter filter) Set tree filter Parameters filter:TreeFilter a `org.eclipse.jgit.treewalk.filter.TreeFilter` object. Returns:SubmoduleWalk this generator

public SubmoduleWalk setFilter(TreeFilter filter)

Set tree filter

Parameters

filter:TreeFilter: a org.eclipse.jgit.treewalk.filter.TreeFilter object.

Returns:SubmoduleWalk

this generator

setModulesConfig	back to summary
public SubmoduleWalk setModulesConfig(Config config) Set the config used by this walk. This method need only be called if constructing a walk manually instead of with one of the static factory methods above. Parameters config:Config .gitmodules config object Returns:SubmoduleWalk this generator

setModulesConfig

back to summary

public SubmoduleWalk setModulesConfig(Config config)

Set the config used by this walk. This method need only be called if constructing a walk manually instead of with one of the static factory methods above.

Parameters

config:Config: .gitmodules config object

Returns:SubmoduleWalk

this generator

setRootTree back to summary

setRootTree	back to summary
public SubmoduleWalk setRootTree(AbstractTreeIterator tree) Set the tree used by this walk for finding `.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. Parameters tree:AbstractTreeIterator tree containing .gitmodules Returns:SubmoduleWalk this generator

public SubmoduleWalk setRootTree(AbstractTreeIterator tree)

Set the tree used by this walk for finding .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.

Parameters

tree:AbstractTreeIterator: tree containing .gitmodules

Returns:SubmoduleWalk

this generator

setRootTree back to summary

setRootTree	back to summary
public SubmoduleWalk setRootTree(AnyObjectId id) throws IOException Set the tree used by this walk for finding `.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. Parameters id:AnyObjectId ID of a tree containing .gitmodules Returns:SubmoduleWalk this generator Exceptions IOException: if an IO error occurred

public SubmoduleWalk setRootTree(AnyObjectId id) throws IOException

Set the tree used by this walk for finding .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.

Parameters

id:AnyObjectId: ID of a tree containing .gitmodules

Returns:SubmoduleWalk

this generator

Exceptions

IOException:: if an IO error occurred

setTree back to summary

public SubmoduleWalk setTree(AbstractTreeIterator iterator) throws CorruptObjectException

Set the tree iterator used for finding submodule entries

Parameters

iterator:AbstractTreeIterator: an org.eclipse.jgit.treewalk.AbstractTreeIterator object.

Returns:SubmoduleWalk

this generator

Exceptions

CorruptObjectException:: if a corrupt object was found

setTree back to summary

public SubmoduleWalk setTree(AnyObjectId treeId) throws IOException

Set the tree used for finding submodule entries

Parameters

treeId:AnyObjectId: an org.eclipse.jgit.lib.AnyObjectId object.

Returns:SubmoduleWalk

this generator

Exceptions

IOException:: if an IO error occurred
IncorrectObjectTypeException:: if object has unexpected type
MissingObjectException:: if object is missing

Modifier and Type	Field and Description
public static final SubmoduleWalk.IgnoreSubmoduleMode	ALL Ignore all modifications to submodules
public static final SubmoduleWalk.IgnoreSubmoduleMode	DIRTY Ignore changes to the working tree of a submodule
public static final SubmoduleWalk.IgnoreSubmoduleMode	NONE Ignore nothing.
public static final SubmoduleWalk.IgnoreSubmoduleMode	UNTRACKED Ignore changes to untracked files in the working tree of a submodule

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

public Class SubmoduleWalk

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SubmoduleWalk.IgnoreSubmoduleMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail