Package org.eclipse.jgit.revwalk.filter

Class ObjectFilter

java.lang.Object

org.eclipse.jgit.revwalk.filter.ObjectFilter

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 Summary

Fields

Modifier and Type	Field	Description
static ObjectFilter	ALL	Default filter that always returns true.

Constructor Summary

Constructors

Constructor	Description
ObjectFilter()

Method Summary

Modifier and Type	Method	Description
abstract boolean	include(ObjectWalk walker, AnyObjectId objid)	Determine if the named object should be included in the walk.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final ObjectFilter ALL

Default filter that always returns true.

Constructor Detail

ObjectFilter

public ObjectFilter()

Method Detail

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.