Class ObjectFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.ObjectFilter
Direct Known Subclasses:
BitmapWalker.BitmapObjectFilter, ObjectFilter.AllFilter

public abstract class ObjectFilter extends Object
Selects interesting objects when walking.

Applications should install the filter on an ObjectWalk by ObjectWalk.setObjectFilter(ObjectFilter) prior to starting traversal.

Since:
4.0
  • Field Details

    • ALL

      public static final ObjectFilter ALL
      Default filter that always returns true.
  • Constructor Details

    • ObjectFilter

      public ObjectFilter()
  • Method Details

    • include

      public abstract boolean include(ObjectWalk walker, AnyObjectId objid) throws MissingObjectException, IncorrectObjectTypeException, IOException
      Determine if the named object should be included in the walk.
      Parameters:
      walker - the active walker this filter is being invoked from within.
      objid - the object currently being tested.
      Returns:
      true if the named object should be included in the walk.
      Throws:
      MissingObjectException - an object the filter needed to consult to determine its answer was missing
      IncorrectObjectTypeException - an object the filter needed to consult to determine its answer was of the wrong type
      IOException - an object the filter needed to consult to determine its answer could not be read.