org.eclipse.jgit.api

Class Status

java.lang.Object

org.eclipse.jgit.api.Status

public class Status
extends java.lang.Object

A class telling where the working-tree, the index and the current HEAD differ from each other. Collections are exposed containing the paths of the modified files. E.g. to find out which files are dirty in the working tree (modified but not added) you would inspect the collection returned by getModified().

The same path can be returned by multiple getters. E.g. if a modification has been added to the index and afterwards the corresponding working tree file is again modified this path will be returned by getModified() and getChanged()

Constructor Summary

Constructors

Constructor and Description
Status(IndexDiff diff)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAdded()
java.util.Set<java.lang.String>	getChanged()
java.util.Set<java.lang.String>	getConflicting()
java.util.Set<java.lang.String>	getMissing()
java.util.Set<java.lang.String>	getModified()
java.util.Set<java.lang.String>	getRemoved()
java.util.Set<java.lang.String>	getUntracked()
boolean	isClean()

Methods inherited from class java.lang.Object

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

Constructor Detail

Status

public Status(IndexDiff diff)

Parameters:

diff -

Method Detail

isClean

public boolean isClean()

Returns:

true if no differences exist between the working-tree, the index, and the current HEAD, false if differences do exist

getAdded

public java.util.Set<java.lang.String> getAdded()

Returns:

list of files added to the index, not in HEAD (e.g. what you get if you call 'git add ...' on a newly created file)

getChanged

public java.util.Set<java.lang.String> getChanged()

Returns:

list of files changed from HEAD to index (e.g. what you get if you modify an existing file and call 'git add ...' on it)

getRemoved

public java.util.Set<java.lang.String> getRemoved()

Returns:

list of files removed from index, but in HEAD (e.g. what you get if you call 'git rm ...' on a existing file)

getMissing

public java.util.Set<java.lang.String> getMissing()

Returns:

list of files in index, but not filesystem (e.g. what you get if you call 'rm ...' on a existing file)

getModified

public java.util.Set<java.lang.String> getModified()

Returns:

list of files modified on disk relative to the index (e.g. what you get if you modify an existing file without adding it to the index)

getUntracked

public java.util.Set<java.lang.String> getUntracked()

Returns:

list of files that are not ignored, and not in the index. (e.g. what you get if you create a new file without adding it to the index)

getConflicting

public java.util.Set<java.lang.String> getConflicting()

Returns:

list of files that are in conflict. (e.g what you get if you modify file that was modified by someone else in the meantime)