public Class PathFilter

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

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

x.clone().equals(x)

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:PathFilter

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

Create a new tree filter for a user supplied path.

Path strings are relative to the root of the repository. If the user's input should be assumed relative to a subdirectory of the repository the caller must prepend the subdirectory's path prior to creating the filter.

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

Parameters

path:String

the path to filter on. Must not be the empty string. All trailing '/' characters will be trimmed before string's length is checked or is used as part of the constructed filter.

Returns:PathFilter

a new filter for the requested path.

Exceptions

IllegalArgumentException:

the path supplied was the empty string.

Get the path this filter matches.

Returns:String

the path this filter matches.

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

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

If this filter checks that at least one of the paths in a set has been modified, returns that set of paths to be checked against a changed path filter. Otherwise, returns empty.

Returns:Optional<Set<byte[]>>

a set of paths, or empty

Annotations

@Override

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

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

Whether the path length of this filter matches the length of the current path of the supplied TreeWalk.

Parameters

walker:TreeWalk

The walk to check against.

Returns:boolean

true if the path length of this filter matches the length of the current path of the supplied TreeWalk.

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

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

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

This method extends the result returned by 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.

Parameters

walker:TreeWalk

the walker the filter needs to examine.

Returns:int

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

Annotations

@Override

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

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

@SuppressWarnings:nls