java.lang.Object
org.eclipse.jgit.api.GitCommand<Collection<SubmoduleDeinitResult>>
org.eclipse.jgit.api.SubmoduleDeinitCommand
- All Implemented Interfaces:
Callable<Collection<SubmoduleDeinitResult>>
A class used to execute a submodule deinit command.
This will remove the module(s) from the working tree, but won't affect .git/modules.
- Since:
- 4.10
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
The user tried to deinitialize a submodule that doesn't exist in the index.static enum
The effect of a submodule deinit command for a given path -
Field Summary
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor of SubmoduleDeinitCommand -
Method Summary
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
Constructor Details
-
SubmoduleDeinitCommand
Constructor of SubmoduleDeinitCommand- Parameters:
repo
- repository this command works on
-
-
Method Details
-
call
Execute the command
- Specified by:
call
in interfaceCallable<Collection<SubmoduleDeinitResult>>
- Specified by:
call
in classGitCommand<Collection<SubmoduleDeinitResult>>
- Returns:
- the set of repositories successfully deinitialized.
- Throws:
SubmoduleDeinitCommand.NoSuchSubmoduleException
- if any of the submodules which we might want to deinitialize don't existGitAPIException
-
addPath
Add repository-relative submodule path to deinitialize- Parameters:
path
- (with/
as separator)- Returns:
- this command
-
setForce
Iftrue
, call() will deinitialize modules with local changes; else it will refuse to do so.- Parameters:
force
- execute the command forcefully if there are local modifications- Returns:
this
-