SubmoduleStatusCommand

java.lang.Object
- org.eclipse.jgit.api.GitCommand<java.util.Map<java.lang.String,SubmoduleStatus>>
- - org.eclipse.jgit.api.SubmoduleStatusCommand

All Implemented Interfaces:

java.util.concurrent.Callable<java.util.Map<java.lang.String,SubmoduleStatus>>
```
public class SubmoduleStatusCommand
extends GitCommand<java.util.Map<java.lang.String,SubmoduleStatus>>
```
A class used to execute a submodule status command.

See Also:

Git documentation about submodules

Field Summary

Fields
Modifier and Type Field Description

private java.util.Collection<java.lang.String> paths
- Fields inherited from class org.eclipse.jgit.api.GitCommand
  repo

Constructor Summary

Constructors
Constructor Description

SubmoduleStatusCommand(Repository repo)
Constructor for SubmoduleStatusCommand.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SubmoduleStatusCommand`	`addPath(java.lang.String path)`	Add repository-relative submodule path to limit status reporting to
`java.util.Map<java.lang.String,SubmoduleStatus>`	`call()`
`private SubmoduleStatus`	`getStatus(SubmoduleWalk generator)`

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

- Field Detail
  - paths
```
private final java.util.Collection<java.lang.String> paths
```
- Constructor Detail
  - SubmoduleStatusCommand
```
public SubmoduleStatusCommand(Repository repo)
```
    Constructor for SubmoduleStatusCommand.
    
    Parameters:
    
    repo - a Repository object.
- Method Detail
  - addPath
```
public SubmoduleStatusCommand addPath(java.lang.String path)
```
    Add repository-relative submodule path to limit status reporting to
    
    Parameters:
    
    path - (with / as separator)
    
    Returns:
    
    this command
  - call
```
public java.util.Map<java.lang.String,SubmoduleStatus> call()
                                                           throws GitAPIException
```
    Execute the command
    
    Specified by:
    
    call in interface java.util.concurrent.Callable<java.util.Map<java.lang.String,SubmoduleStatus>>
    
    Specified by:
    
    call in class GitCommand<java.util.Map<java.lang.String,SubmoduleStatus>>
    
    Throws:
    
    GitAPIException
  - getStatus
```
private SubmoduleStatus getStatus(SubmoduleWalk generator)
                           throws java.io.IOException,
                                  ConfigInvalidException
```
    Throws:
    
    java.io.IOException
    
    ConfigInvalidException