Modifier and Type	Class and Description
public static class	SubmoduleDeinitCommand.NoSuchSubmoduleException The user tried to deinitialize a submodule that doesn't exist in the index.
public static enum	SubmoduleDeinitCommand.SubmoduleDeinitStatus The effect of a submodule deinit command for a given path

Modifier and Type	Field and Description
private boolean	force
private final Collection<String>	paths

Access	Constructor and Description
public	SubmoduleDeinitCommand(Repository repository this command works on repo) Constructor of SubmoduleDeinitCommand

Method Summary

Modifier and Type	Method and Description
public SubmoduleDeinitCommand	Returns: this command addPath(String (with `/` as separator) path) Add repository-relative submodule path to deinitialize
public Collection<SubmoduleDeinitResult>	Returns: the set of repositories successfully deinitialized. 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.
private SubmoduleDeinitCommand.SubmoduleDeinitStatus	Returns: status of the command checkDirty(RevWalk used to walk commit graph revWalk, String path of the submodule path) Check if a submodule is dirty.
private void	deinit(String the path to clean path) Recursively delete the contents of path, but leave path as an empty directory
public SubmoduleDeinitCommand	Returns: `this` setForce(boolean execute the command forcefully if there are local modifications force) If `true`, call() will deinitialize modules with local changes; else it will refuse to do so.
private boolean	Returns: `true` if path exists and is a submodule in index, `false` otherwise submoduleExists(String path of the submodule path) Check if this path is a submodule by checking the index, which is what git submodule deinit checks.

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

Field Detail

force	back to summary
private boolean force

paths	back to summary
private final Collection<String> paths

Constructor Detail

SubmoduleDeinitCommand	back to summary
public SubmoduleDeinitCommand(Repository repo) Constructor of SubmoduleDeinitCommand Parameters repo:Repository repository this command works on

SubmoduleDeinitCommand

back to summary

public SubmoduleDeinitCommand(Repository repo)

Constructor of SubmoduleDeinitCommand

Parameters

repo:Repository: repository this command works on

Method Detail

addPath back to summary

addPath	back to summary
public SubmoduleDeinitCommand addPath(String path) Add repository-relative submodule path to deinitialize Parameters path:String (with `/` as separator) Returns:SubmoduleDeinitCommand this command

public SubmoduleDeinitCommand addPath(String path)

Add repository-relative submodule path to deinitialize

Parameters

path:String: (with / as separator)

Returns:SubmoduleDeinitCommand

this command

call	back to summary
public Collection<SubmoduleDeinitResult> 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:Collection<SubmoduleDeinitResult> the set of repositories successfully deinitialized. Annotations @Override Exceptions NoSuchSubmoduleException: if any of the submodules which we might want to deinitialize don't exist

call

back to summary

public Collection<SubmoduleDeinitResult> 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:Collection<SubmoduleDeinitResult>

the set of repositories successfully deinitialized.

Annotations

@Override

Exceptions

NoSuchSubmoduleException:: if any of the submodules which we might want to deinitialize don't exist

checkDirty	back to summary
private SubmoduleDeinitCommand.SubmoduleDeinitStatus checkDirty(RevWalk revWalk, String path) throws GitAPIException, IOException Check if a submodule is dirty. A submodule is dirty if there are local changes to the submodule relative to its HEAD, including untracked files. It is also dirty if the HEAD of the submodule does not match the value in the parent repo's index or HEAD. Parameters revWalk:RevWalk used to walk commit graph path:String path of the submodule Returns:SubmoduleDeinitCommand.SubmoduleDeinitStatus status of the command Exceptions GitAPIException: if JGit API failed IOException: if an IO error occurred

checkDirty

back to summary

private SubmoduleDeinitCommand.SubmoduleDeinitStatus checkDirty(RevWalk revWalk, String path) throws GitAPIException, IOException

Check if a submodule is dirty. A submodule is dirty if there are local changes to the submodule relative to its HEAD, including untracked files. It is also dirty if the HEAD of the submodule does not match the value in the parent repo's index or HEAD.

Parameters

revWalk:RevWalk: used to walk commit graph
path:String: path of the submodule

Returns:SubmoduleDeinitCommand.SubmoduleDeinitStatus

status of the command

Exceptions

GitAPIException:: if JGit API failed
IOException:: if an IO error occurred

deinit	back to summary
private void deinit(String path) throws IOException Recursively delete the contents of path, but leave path as an empty directory Parameters path:String the path to clean Exceptions IOException: if an IO error occurred

deinit

back to summary

private void deinit(String path) throws IOException

Recursively delete the *contents* of path, but leave path as an empty directory

Parameters

path:String: the path to clean

Exceptions

IOException:: if an IO error occurred

setForce back to summary

setForce	back to summary
public SubmoduleDeinitCommand setForce(boolean force) If `true`, call() will deinitialize modules with local changes; else it will refuse to do so. Parameters force:boolean execute the command forcefully if there are local modifications Returns:SubmoduleDeinitCommand `this`

public SubmoduleDeinitCommand setForce(boolean force)

If true, call() will deinitialize modules with local changes; else it will refuse to do so.

Parameters

force:boolean: execute the command forcefully if there are local modifications

Returns:SubmoduleDeinitCommand

this

submoduleExists back to summary

submoduleExists	back to summary
private boolean submoduleExists(String path) throws IOException Check if this path is a submodule by checking the index, which is what git submodule deinit checks. Parameters path:String path of the submodule Returns:boolean `true` if path exists and is a submodule in index, `false` otherwise Exceptions IOException: if an IO error occurred

private boolean submoduleExists(String path) throws IOException

Check if this path is a submodule by checking the index, which is what git submodule deinit checks.

Parameters

path:String: path of the submodule

Returns:boolean

true if path exists and is a submodule in index, false otherwise

Exceptions

IOException:: if an IO error occurred

org.eclipse.jgit.api back to summary

public Class SubmoduleDeinitCommand.NoSuchSubmoduleException

Class Inheritance

extends GitAPIException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.eclipse.jgit.api.errors.GitAPIException
org.eclipse.jgit.api.SubmoduleDeinitCommand.NoSuchSubmoduleException

The user tried to deinitialize a submodule that doesn't exist in the index.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.eclipse.jgit.api.errors.GitAPIException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	NoSuchSubmoduleException(String path of non-existing submodule path) Constructor of NoSuchSubmoduleException

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.eclipse.jgit.api.errors.GitAPIException.serialVersionUID.

Constructor Detail

NoSuchSubmoduleException	back to summary
public NoSuchSubmoduleException(String path) Constructor of NoSuchSubmoduleException Parameters path:String path of non-existing submodule

NoSuchSubmoduleException

back to summary

public NoSuchSubmoduleException(String path)

Constructor of NoSuchSubmoduleException

Parameters

path:String: path of non-existing submodule

org.eclipse.jgit.api back to summary

public final Enum SubmoduleDeinitCommand.SubmoduleDeinitStatus

Class Inheritance

extends Enum<SubmoduleDeinitCommand.SubmoduleDeinitStatus>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.api.SubmoduleDeinitCommand.SubmoduleDeinitStatus

The effect of a submodule deinit command for a given path

Field Summary

Modifier and Type	Field and Description
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus	ALREADY_DEINITIALIZED The submodule was not initialized in the first place
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus	DIRTY The submodule had local changes and force was false
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus	FORCED The submodule had local changes, but was deinitialized successfully
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus	SUCCESS The submodule was deinitialized

Constructor Summary

Access	Constructor and Description
private	SubmoduleDeinitStatus()

Method Summary

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

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALREADY_DEINITIALIZED	back to summary
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus ALREADY_DEINITIALIZED The submodule was not initialized in the first place

DIRTY	back to summary
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus DIRTY The submodule had local changes and force was false

FORCED	back to summary
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus FORCED The submodule had local changes, but was deinitialized successfully

SUCCESS	back to summary
public static final SubmoduleDeinitCommand.SubmoduleDeinitStatus SUCCESS The submodule was deinitialized

Constructor Detail

SubmoduleDeinitStatus	back to summary
private SubmoduleDeinitStatus()

Method Detail

valueOf	back to summary
public static SubmoduleDeinitCommand.SubmoduleDeinitStatus valueOf(String name)

values	back to summary
public static SubmoduleDeinitCommand.SubmoduleDeinitStatus[] values()

public Class SubmoduleDeinitCommand

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SubmoduleDeinitCommand.NoSuchSubmoduleException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public final Enum SubmoduleDeinitCommand.SubmoduleDeinitStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail