Module org.eclipse.jgit
Package org.eclipse.jgit.treewalk.filter

Class ChangedPathTreeFilter

java.lang.Object
org.eclipse.jgit.treewalk.filter.TreeFilter
org.eclipse.jgit.treewalk.filter.ChangedPathTreeFilter
public class ChangedPathTreeFilter extends TreeFilter
Filter tree entries that modified the contents of particular file paths.

Equivalent to AndTreeFilter(PathFilter, AnyDiffFilter). This filter uses ChangedPathFilter (bloom filters) when available to discard commits without diffing their trees.

Since:
7.3

  • Method Details

    • create

      public static ChangedPathTreeFilter create(String... paths)
      Create a TreeFilter for trees modifying one or more user supplied paths.

      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.

      Paths may appear in any order within the collection. Sorting may be done internally when the group is constructed if doing so will improve path matching performance.

      Parameters:
      paths - the paths to test against. Must have at least one entry.
      Returns:
      a new filter for the list of paths supplied.

    • shouldTreeWalk

      public boolean shouldTreeWalk(RevCommit c, RevWalk rw, TreeFilter.MutableBoolean cpfUsed)
      Description copied from class: TreeFilter
      Return true if the tree entries within this commit require TreeFilter.include(TreeWalk) to correctly determine whether they are interesting to report.

      Otherwise, all tree entries within this commit are UNINTERESTING for this tree filter.

      Overrides:
      shouldTreeWalk in class TreeFilter
      Parameters:
      c - the commit being considered by the TreeFilter.
      rw - the RevWalk used in retrieving relevant commit data.
      cpfUsed - if not null, it reports if the changedPathFilter was used in this method
      Returns:
      True if the tree entries within c require TreeFilter.include(TreeWalk).

    • include

      public boolean include(TreeWalk walker) throws IOException
      Description copied from class: TreeFilter
      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.

    • shouldBeRecursive

      public boolean shouldBeRecursive()
      Description copied from class: TreeFilter
      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 ChangedPathTreeFilter clone()
      Description copied from class: TreeFilter
      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

    • getPaths

      public List<String> getPaths()
      Get the paths this filter matches.
      Returns:
      the paths this filter matches.

    • toString

      public String toString()
      Overrides:
      toString in class TreeFilter