JGit 7.2.0.202503040940-r · org.eclipse.jgit.treewalk.filter.IndexDiffFilter

A performance optimized variant of org.eclipse.jgit.treewalk.filter.TreeFilter#ANY_DIFF which should be used when among the walked trees there is a org.eclipse.jgit.dircache.DirCacheIterator and a org.eclipse.jgit.treewalk.WorkingTreeIterator. Please see the documentation of org.eclipse.jgit.treewalk.filter.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 org.eclipse.jgit.treewalk.filter.TreeFilter#ANY_DIFF this filter takes care to first compare the entry from the org.eclipse.jgit.dircache.DirCacheIterator with the entries from all other iterators besides the org.eclipse.jgit.treewalk.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 org.eclipse.jgit.treewalk.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 org.eclipse.jgit.treewalk.TreeWalks. Always construct a new instance of this filter for each TreeWalk.

Field Summary

Modifier and Type	Field and Description
private final int	dirCache
private final boolean	honorIgnores
private final Set<String>	ignoredPaths
private final ArrayDeque<String>	untrackedFolders
private final ArrayDeque<String>	untrackedParentFolders
private final int	workingTree

Inherited from org.eclipse.jgit.treewalk.filter.TreeFilter:: ALL ANY_DIFF

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	IndexDiffFilter(int the index of the `org.eclipse.jgit.dircache.DirCacheIterator` in the associated treewalk dirCacheIndex, int the index of the `org.eclipse.jgit.treewalk.WorkingTreeIterator` in the associated treewalk workingTreeIndex) Creates a new instance of this filter.
public	IndexDiffFilter(int the index of the `org.eclipse.jgit.dircache.DirCacheIterator` in the associated treewalk dirCacheIndex, int the index of the `org.eclipse.jgit.treewalk.WorkingTreeIterator` in the associated treewalk workingTreeIndex, boolean true if the filter should skip working tree files that are declared as ignored by the standard exclude mechanisms. honorIgnores) Creates a new instance of this filter.

public

IndexDiffFilter(int

the index of the org.eclipse.jgit.dircache.DirCacheIterator in the associated treewalk

dirCacheIndex, int

the index of the org.eclipse.jgit.treewalk.WorkingTreeIterator in the associated treewalk

workingTreeIndex)

Creates a new instance of this filter.

public

IndexDiffFilter(int

the index of the org.eclipse.jgit.dircache.DirCacheIterator in the associated treewalk

dirCacheIndex, int

the index of the org.eclipse.jgit.treewalk.WorkingTreeIterator in the associated treewalk

workingTreeIndex, boolean

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

honorIgnores)

Creates a new instance of this filter.

Method Summary

Modifier and Type	Method and Description
public TreeFilter	clone() Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.clone. Creates and returns a copy of this object.
private void	copyUntrackedFolders(String the current path of the treewalk currentPath) Copy all entries which are still in untrackedParentFolders and which belong to a path this treewalk has left into untrackedFolders.
public Set<String>	Returns: ignored paths getIgnoredPaths() The method returns the list of ignored files and folders.
public List<String>	Returns: all paths of folders which contain only untracked files/folders. If on the associated treewalk postorder traversal was turned on (see `org.eclipse.jgit.treewalk.TreeWalk#setPostOrderTraversal(boolean)`) then an empty list will be returned. getUntrackedFolders() Getter for the field `untrackedFolders`.
public boolean	include(TreeWalk the walker the filter needs to examine. tw) Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.include. Determine if the current entry is interesting to report.
public boolean	shouldBeRecursive() Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.shouldBeRecursive. Does this tree filter require a recursive walk to match everything?
public String	toString() Overrides org.eclipse.jgit.treewalk.filter.TreeFilter.toString. Returns a string representation of the object.
private WorkingTreeIterator	workingTree(TreeWalk tw)

Inherited from org.eclipse.jgit.treewalk.filter.TreeFilter:: getPathsBestEffort matchFilter negate

Field Detail

dirCache	back to summary
private final int dirCache

honorIgnores	back to summary
private final boolean honorIgnores

ignoredPaths	back to summary
private final Set<String> ignoredPaths

untrackedFolders	back to summary
private final ArrayDeque<String> untrackedFolders

untrackedParentFolders	back to summary
private final ArrayDeque<String> untrackedParentFolders

workingTree	back to summary
private final int workingTree

Constructor Detail

IndexDiffFilter back to summary

IndexDiffFilter	back to summary
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:int the index of the `org.eclipse.jgit.dircache.DirCacheIterator` in the associated treewalk workingTreeIndex:int the index of the `org.eclipse.jgit.treewalk.WorkingTreeIterator` in the associated treewalk

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:int: the index of the org.eclipse.jgit.dircache.DirCacheIterator in the associated treewalk
workingTreeIndex:int: the index of the org.eclipse.jgit.treewalk.WorkingTreeIterator in the associated treewalk

IndexDiffFilter back to summary

IndexDiffFilter	back to summary
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:int the index of the `org.eclipse.jgit.dircache.DirCacheIterator` in the associated treewalk workingTreeIndex:int the index of the `org.eclipse.jgit.treewalk.WorkingTreeIterator` in the associated treewalk honorIgnores:boolean true if the filter should skip working tree files that are declared as ignored by the standard exclude mechanisms.

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:int: the index of the org.eclipse.jgit.dircache.DirCacheIterator in the associated treewalk
workingTreeIndex:int: the index of the org.eclipse.jgit.treewalk.WorkingTreeIterator in the associated treewalk
honorIgnores:boolean: true if the filter should skip working tree files that are declared as ignored by the standard exclude mechanisms.

Method Detail

clone back to summary

clone	back to summary
public TreeFilter clone() Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.clone. Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. 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. Returns:TreeFilter Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

public TreeFilter clone()

Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.clone.

Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified. 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.

Returns:TreeFilter

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

copyUntrackedFolders	back to summary
private void copyUntrackedFolders(String currentPath) Copy all entries which are still in untrackedParentFolders and which belong to a path this treewalk has left into untrackedFolders. It is sure that we will not find any tracked files underneath these paths. Therefore these paths definitely belong to untracked folders. Parameters currentPath:String the current path of the treewalk

copyUntrackedFolders

back to summary

private void copyUntrackedFolders(String currentPath)

Copy all entries which are still in untrackedParentFolders and which belong to a path this treewalk has left into untrackedFolders. It is sure that we will not find any tracked files underneath these paths. Therefore these paths definitely belong to untracked folders.

Parameters

currentPath:String: the current path of the treewalk

getIgnoredPaths	back to summary
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:Set<String> ignored paths

getIgnoredPaths

back to summary

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:Set<String>: ignored paths

getUntrackedFolders back to summary

getUntrackedFolders	back to summary
public List<String> getUntrackedFolders() Getter for the field `untrackedFolders`. Returns:List<String> all paths of folders which contain only untracked files/folders. If on the associated treewalk postorder traversal was turned on (see `org.eclipse.jgit.treewalk.TreeWalk#setPostOrderTraversal(boolean)`) then an empty list will be returned.

public List<String> getUntrackedFolders()

Getter for the field untrackedFolders.

Returns:List<String>: all paths of folders which contain only untracked files/folders. If on the associated treewalk postorder traversal was turned on (see org.eclipse.jgit.treewalk.TreeWalk#setPostOrderTraversal(boolean)) then an empty list will be returned.

include back to summary

include	back to summary
public boolean include(TreeWalk tw) throws MissingObjectException, IncorrectObjectTypeException, IOException Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.include. Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.include. Determine if the current entry is interesting to report. This method is consulted for subtree entries even if `org.eclipse.jgit.treewalk.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. Parameters tw:TreeWalk the walker the filter needs to examine. Returns:boolean true if the current entry should be seen by the application; false to hide the entry. Annotations @Override Exceptions 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.

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

Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.include.

Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.include.

Determine if the current entry is interesting to report.

This method is consulted for subtree entries even if org.eclipse.jgit.treewalk.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.

Parameters

tw:TreeWalk: the walker the filter needs to examine.

Returns:boolean

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

Annotations

@Override

Exceptions

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	back to summary
public boolean shouldBeRecursive() Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.shouldBeRecursive. Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.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. Returns:boolean 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. Annotations @Override

shouldBeRecursive

back to summary

public boolean shouldBeRecursive()

Implements abstract org.eclipse.jgit.treewalk.filter.TreeFilter.shouldBeRecursive.

Doc from org.eclipse.jgit.treewalk.filter.TreeFilter.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.

Returns:boolean

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.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.eclipse.jgit.treewalk.filter.TreeFilter.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides org.eclipse.jgit.treewalk.filter.TreeFilter.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

workingTree	back to summary
private WorkingTreeIterator workingTree(TreeWalk tw)

public Class IndexDiffFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail