Package org.eclipse.jgit.treewalk.filter

Class PathSuffixFilter

java.lang.Object

org.eclipse.jgit.treewalk.filter.TreeFilter

org.eclipse.jgit.treewalk.filter.PathSuffixFilter

public class PathSuffixFilter
extends TreeFilter

Includes tree entries only if they end with the configured path (suffix match).

For example, PathSuffixFilter.create(".txt") will match all paths ending in .txt.

Using this filter is recommended instead of filtering the entries using TreeWalk.getPathString() and endsWith or some other type of string match function.

Field Summary

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

ALL, ANY_DIFF

Method Summary

Modifier and Type	Method	Description
TreeFilter	clone()	Clone this tree filter, including its parameters.
static PathSuffixFilter	create(String path)	Create a new tree filter for a user supplied path suffix.
boolean	include(TreeWalk walker)	Determine if the current entry is interesting to report.
int	matchFilter(TreeWalk walker)	Determine if the current entry is a parent, a match, or no match.
boolean	shouldBeRecursive()	Does this tree filter require a recursive walk to match everything?

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

negate, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static PathSuffixFilter create(String path)

Create a new tree filter for a user supplied path suffix.

Path strings use '/' to delimit directories on all platforms.

Parameters:

path - the path suffix to filter on. Must not be the empty string.

Returns:

a new filter for the requested path.

Throws:

IllegalArgumentException - the path supplied was the empty string.

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

include

public boolean include(TreeWalk walker)
                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:

walker - 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.

matchFilter

public int matchFilter(TreeWalk walker)
                throws MissingObjectException,
                       IncorrectObjectTypeException,
                       IOException

Description copied from class: TreeFilter

Determine if the current entry is a parent, a match, or no match.

This method extends the result returned by TreeFilter.include(TreeWalk) with a third option (-1), splitting the value true. This gives the application a possibility to distinguish between an exact match and the case when a subtree to the current entry might be a match.

Overrides:

matchFilter in class TreeFilter

Parameters:

walker - the walker the filter needs to examine.

Returns:

-1 if the current entry is a parent of the filter but no exact match has been made; 0 if the current entry should be seen by the application; 1 if it should be hidden.

Throws:

MissingObjectException - as thrown by TreeFilter.include(TreeWalk)

IncorrectObjectTypeException - as thrown by TreeFilter.include(TreeWalk)

IOException - as thrown by TreeFilter.include(TreeWalk)

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.