Module org.eclipse.jgit

Package org.eclipse.jgit.api

Class SubmoduleDeinitCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Collection<SubmoduleDeinitResult>>

org.eclipse.jgit.api.SubmoduleDeinitCommand

All Implemented Interfaces:

Callable<Collection<SubmoduleDeinitResult>>

public class SubmoduleDeinitCommand
extends GitCommand<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:

• Git documentation about submodules

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubmoduleDeinitCommand.NoSuchSubmoduleException	The user tried to deinitialize a submodule that doesn't exist in the index.
static enum	SubmoduleDeinitCommand.SubmoduleDeinitStatus	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

Constructors

Constructor	Description
SubmoduleDeinitCommand(Repository repo)	Constructor of SubmoduleDeinitCommand

Method Summary

Modifier and Type	Method	Description
SubmoduleDeinitCommand	addPath(String path)	Add repository-relative submodule path to deinitialize
Collection<SubmoduleDeinitResult>	call()
SubmoduleDeinitCommand	setForce(boolean force)	If true, call() will deinitialize modules with local changes; else it will refuse to do so.

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubmoduleDeinitCommand

public SubmoduleDeinitCommand(Repository repo)

Constructor of SubmoduleDeinitCommand

Parameters:

repo - repository this command works on

Method Details

call

public Collection<SubmoduleDeinitResult> call()
                                       throws GitAPIException

Execute the command

Specified by:

call in interface Callable<Collection<SubmoduleDeinitResult>>

Specified by:

call in class GitCommand<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 exist

GitAPIException

addPath

public SubmoduleDeinitCommand addPath(String path)

Add repository-relative submodule path to deinitialize

Parameters:

path - (with / as separator)

Returns:

this command

setForce

public SubmoduleDeinitCommand setForce(boolean force)

If true, 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