Package org.eclipse.jgit.treewalk.filter

Class IndexDiffFilter

java.lang.Object

org.eclipse.jgit.treewalk.filter.TreeFilter

org.eclipse.jgit.treewalk.filter.IndexDiffFilter

public class IndexDiffFilter
extends TreeFilter

A performance optimized variant of TreeFilter.ANY_DIFF which should be used when among the walked trees there is a DirCacheIterator and a WorkingTreeIterator. Please see the documentation of TreeFilter.ANY_DIFF for a basic description of the semantics.

This filter tries to avoid computing content ids of the files in the working-tree. In contrast to TreeFilter.ANY_DIFF this filter takes care to first compare the entry from the DirCacheIterator with the entries from all other iterators besides the WorkingTreeIterator. Since all those entries have fast access to content ids that is very fast. If a difference is detected in this step this filter decides to include that path before even looking at the working-tree entry.

If no difference is found then we have to compare index and working-tree as the last step. By making use of WorkingTreeIterator.isModified(org.eclipse.jgit.dircache.DirCacheEntry, boolean, ObjectReader) we can avoid the computation of the content id if the file is not dirty.

Instances of this filter should not be used for multiple TreeWalks. Always construct a new instance of this filter for each TreeWalk.

Field Summary

Fields inherited from class org.eclipse.jgit.treewalk.filter.TreeFilter

ALL, ANY_DIFF

Constructor Summary

Constructors

Constructor	Description
IndexDiffFilter(int dirCacheIndex, int workingTreeIndex)	Creates a new instance of this filter.
IndexDiffFilter(int dirCacheIndex, int workingTreeIndex, boolean honorIgnores)	Creates a new instance of this filter.

Method Summary

Modifier and Type	Method	Description
TreeFilter	clone()	Clone this tree filter, including its parameters.
Set<String>	getIgnoredPaths()	The method returns the list of ignored files and folders.
List<String>	getUntrackedFolders()	Getter for the field untrackedFolders.
boolean	include(TreeWalk tw)	Determine if the current entry is interesting to report.
boolean	shouldBeRecursive()	Does this tree filter require a recursive walk to match everything?
String	toString()

Methods inherited from class org.eclipse.jgit.treewalk.filter.TreeFilter

matchFilter, negate

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDiffFilter

public IndexDiffFilter(int dirCacheIndex,
                       int workingTreeIndex)

Creates a new instance of this filter. Do not use an instance of this filter in multiple treewalks.

Parameters:

dirCacheIndex - the index of the DirCacheIterator in the associated treewalk

workingTreeIndex - the index of the WorkingTreeIterator in the associated treewalk

IndexDiffFilter

public IndexDiffFilter(int dirCacheIndex,
                       int workingTreeIndex,
                       boolean honorIgnores)

Creates a new instance of this filter. Do not use an instance of this filter in multiple treewalks.

Parameters:

dirCacheIndex - the index of the DirCacheIterator in the associated treewalk

workingTreeIndex - the index of the WorkingTreeIterator in the associated treewalk

honorIgnores - true if the filter should skip working tree files that are declared as ignored by the standard exclude mechanisms.

Method Detail

include

public boolean include(TreeWalk tw)
                throws MissingObjectException,
                       IncorrectObjectTypeException,
                       IOException

Determine if the current entry is interesting to report.

This method is consulted for subtree entries even if TreeWalk.isRecursive() is enabled. The consultation allows the filter to bypass subtree recursion on a case-by-case basis, even when recursion is enabled at the application level.

Specified by:

include in class TreeFilter

Parameters:

tw - the walker the filter needs to examine.

Returns:

true if the current entry should be seen by the application; false to hide the entry.

Throws:

MissingObjectException - an object the filter needs to consult to determine its answer does not exist in the Git repository the walker is operating on. Filtering this current walker entry is impossible without the object.

IncorrectObjectTypeException - an object the filter needed to consult was not of the expected object type. This usually indicates a corrupt repository, as an object link is referencing the wrong type.

IOException - a loose object or pack file could not be read to obtain data necessary for the filter to make its decision.

shouldBeRecursive

public boolean shouldBeRecursive()

Does this tree filter require a recursive walk to match everything?

If this tree filter is matching on full entry path names and its pattern is looking for a '/' then the filter would require a recursive TreeWalk to accurately make its decisions. The walker is not required to enable recursive behavior for any particular filter, this is only a hint.

Specified by:

shouldBeRecursive in class TreeFilter

Returns:

true if the filter would like to have the walker recurse into subtrees to make sure it matches everything correctly; false if the filter does not require entering subtrees.

clone

public TreeFilter clone()

Clone this tree filter, including its parameters.

This is a deep clone. If this filter embeds objects or other filters it must also clone those, to ensure the instances do not share mutable data.

Specified by:

clone in class TreeFilter

toString

public String toString()

Overrides:

toString in class TreeFilter

getIgnoredPaths

public Set<String> getIgnoredPaths()

The method returns the list of ignored files and folders. Only the root folder of an ignored folder hierarchy is reported. If a/b/c is listed in the .gitignore then you should not expect a/b/c/d/e/f to be reported here. Only a/b/c will be reported. Furthermore only ignored files / folders are returned that are NOT in the index.

Returns:

ignored paths

getUntrackedFolders

public List<String> getUntrackedFolders()

Getter for the field untrackedFolders.

Returns:

all paths of folders which contain only untracked files/folders. If on the associated treewalk postorder traversal was turned on (see TreeWalk.setPostOrderTraversal(boolean)) then an empty list will be returned.