Top Description Fields Constructors Methods
org.eclipse.jgit.api

public Class SubmoduleStatusCommand

extends GitCommand<Map<String, SubmoduleStatus>>
Class Inheritance
Imports
java.io.IOException, java.util.ArrayList, .Collection, .HashMap, .Map, org.eclipse.jgit.api.errors.GitAPIException, .JGitInternalException, org.eclipse.jgit.errors.ConfigInvalidException, org.eclipse.jgit.lib.Constants, .ObjectId, .Repository, org.eclipse.jgit.submodule.SubmoduleStatus, .SubmoduleStatusType, .SubmoduleWalk, org.eclipse.jgit.treewalk.filter.PathFilterGroup

A class used to execute a submodule status command.
See Also
Git documentation about submodules

Field Summary

Modifier and TypeField and Description
private final Collection<String>
Inherited from org.eclipse.jgit.api.GitCommand:
repo

Constructor Summary

AccessConstructor and Description
public
SubmoduleStatusCommand(Repository repo)

Constructor for SubmoduleStatusCommand.

Method Summary

Modifier and TypeMethod and Description
public SubmoduleStatusCommand

Returns:

this command
addPath
(String
(with / as separator)
path
)

Add repository-relative submodule path to limit status reporting to

public Map<String, SubmoduleStatus>
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 SubmoduleStatus
Inherited from org.eclipse.jgit.api.GitCommand:
checkCallablegetRepositorysetCallable

Field Detail

pathsback to summary
private final Collection<String> paths

Constructor Detail

SubmoduleStatusCommandback to summary
public SubmoduleStatusCommand(Repository repo)

Constructor for SubmoduleStatusCommand.

Parameters
repo:Repository

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

Method Detail

addPathback to summary
public SubmoduleStatusCommand addPath(String path)

Add repository-relative submodule path to limit status reporting to

Parameters
path:String

(with / as separator)

Returns:SubmoduleStatusCommand

this command

callback to summary
public Map<String, SubmoduleStatus> 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:Map<String, SubmoduleStatus>

Doc from java.util.concurrent.Callable.call.

computed result

Annotations
@Override
getStatusback to summary
private SubmoduleStatus getStatus(SubmoduleWalk generator) throws IOException, ConfigInvalidException