org.netbeans.libs.git

Class GitStatus

java.lang.Object

org.netbeans.libs.git.GitStatus

public final class GitStatus
extends Object

Provides overall information about git status of a certain resource in a git repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitStatus.Status File's status, respectively the state of a file between two trees (can be HEAD vs.

Method Summary

Modifier and Type	Method and Description
GitConflictDescriptor	getConflictDescriptor()
File	getFile()
long	getIndexEntryModificationDate() Returns the time in milliseconds of the last modification timestamp of the index entry.
File	getOldPath()
String	getRelativePath()
GitStatus.Status	getStatusHeadIndex()
GitStatus.Status	getStatusHeadWC()
GitStatus.Status	getStatusIndexWC()
boolean	isConflict() States if the file is currently in conflict and needs to be resolved.
boolean	isCopied()
boolean	isFolder()
boolean	isRenamed()
boolean	isTracked()

Methods inherited from class java.lang.Object

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

Method Detail

getFile

public File getFile()

Returns:

file the status is associated with

getRelativePath

public String getRelativePath()

Returns:

relative path of the file in the repository

getStatusHeadIndex

public GitStatus.Status getStatusHeadIndex()

Returns:

file's state/difference between the HEAD and Index

getStatusIndexWC

public GitStatus.Status getStatusIndexWC()

Returns:

file's state/difference between the Index and Working tree

getStatusHeadWC

public GitStatus.Status getStatusHeadWC()

Returns:

file's state/difference between the HEAD and Working tree

isTracked

public boolean isTracked()

Returns:

true if the file is tracked by Git, meaning it has been already committed or added to the Index

isConflict

public boolean isConflict()

States if the file is currently in conflict and needs to be resolved. If the file is in conflict then:

• more information can be acquired with the getConflictDescriptor method
• contents of the file in conflict (base, mine and others) can be acquired via GitClient.catIndexEntry(java.io.File, int, java.io.OutputStream, org.netbeans.libs.git.progress.ProgressMonitor).

Returns:

true if the file is currently in conflict.

isFolder

public boolean isFolder()

Returns:

true if the file references a folder.

isCopied

public boolean isCopied()

Returns:

true if the file is tracked in the Index as copied.

isRenamed

public boolean isRenamed()

Returns:

true if the file is tracked in the Index as renamed.

getOldPath

public File getOldPath()

Returns:

null if the file is neither copied or renamed, the original file this file has been copied or renamed from otherwise.

getConflictDescriptor

public GitConflictDescriptor getConflictDescriptor()

Returns:

more information about the conflict or null if the file is not in conflict.

getIndexEntryModificationDate

public long getIndexEntryModificationDate()

Returns the time in milliseconds of the last modification timestamp of the index entry. Useful when you need to know when the file was last updated in the index.

Returns:

modification timestamp of the index in milliseconds. When there is no such entry in the index (file was removed or not yet added) this returns -1.

Since:

1.19