Module org.eclipse.jgit
Package org.eclipse.jgit.revwalk

Class FollowFilter

java.lang.Object
org.eclipse.jgit.treewalk.filter.TreeFilter
org.eclipse.jgit.revwalk.FollowFilter
public class FollowFilter extends TreeFilter
Updates the internal path filter to follow copy/renames.

This is a special filter that performs AND(path, ANY_DIFF), but also triggers rename detection so that the path node is updated to include a prior file name as the RevWalk traverses history. The renames found will be reported to a RenameCallback if one is set.

Results with this filter are unpredictable if the path being followed is a subdirectory.

  • Method Details

    • create

      public static FollowFilter create(String path, DiffConfig cfg)
      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 - 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.
      cfg - diff config specifying rename detection options.
      Returns:
      a new filter for the requested path.
      Throws:
      IllegalArgumentException - the path supplied was the empty string.
      Since:
      3.0

    • getPath

      public String getPath()
      Get the path this filter matches.
      Returns:
      the path this filter matches.

    • include

      public boolean include(TreeWalk walker) throws MissingObjectException, IncorrectObjectTypeException, 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.

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

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

    • getPathsBestEffort

      public Optional<Set<byte[]>> getPathsBestEffort()
      Description copied from class: TreeFilter
      If this filter checks that a specific set of paths have all been modified, returns that set of paths to be checked against a changed path filter. Otherwise, returns empty.
      Overrides:
      getPathsBestEffort in class TreeFilter
      Returns:
      a set of paths, or empty

    • 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

    • getRenameCallback

      public RenameCallback getRenameCallback()
      Get the callback to which renames are reported.
      Returns:
      the callback to which renames are reported, or null if none

    • setRenameCallback

      public void setRenameCallback(RenameCallback callback)
      Sets the callback to which renames shall be reported.
      Parameters:
      callback - the callback to use