Top Description Inners Fields Constructors Methods
org.eclipse.jgit.revwalk.filter

public abstract Class OrRevFilter

extends RevFilter
Class Inheritance
Known Direct Subclasses
org.eclipse.jgit.revwalk.filter.OrRevFilter.Binary, org.eclipse.jgit.revwalk.filter.OrRevFilter.List
Imports
java.io.IOException, java.util.Collection, org.eclipse.jgit.errors.IncorrectObjectTypeException, .MissingObjectException, org.eclipse.jgit.internal.JGitText, org.eclipse.jgit.revwalk.RevCommit, .RevWalk

Includes a commit if any subfilters include the same commit.

Classic shortcut behavior is used, so evaluation of the org.eclipse.jgit.revwalk.filter.RevFilter#include(RevWalk, RevCommit) method stops as soon as a true result is obtained. Applications can improve filtering performance by placing faster filters that are more likely to accept a result earlier in the list.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:
ALLMERGE_BASENO_MERGESNONEONLY_MERGES

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static RevFilter

Returns:

a filter that must match at least one input filter.
create
(RevFilter
first filter to test.
a
,
RevFilter
second filter to test.
b
)

Create a filter with two filters, one of which must match.

public static RevFilter

Returns:

a filter that must match at least one input filter.
create
(RevFilter[]
list of filters to match against. Must contain at least 2 filters.
list
)

Create a filter around many filters, one of which must match.

public static RevFilter

Returns:

a filter that must match at least one input filter.
create
(Collection<RevFilter>
list of filters to match against. Must contain at least 2 filters.
list
)

Create a filter around many filters, one of which must match.

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:
cloneincludenegaterequiresCommitBodytoString

Constructor Detail

OrRevFilterback to summary
public OrRevFilter()

Method Detail

createback to summary
public static RevFilter create(RevFilter a, RevFilter b)

Create a filter with two filters, one of which must match.

Parameters
a:RevFilter

first filter to test.

b:RevFilter

second filter to test.

Returns:RevFilter

a filter that must match at least one input filter.

createback to summary
public static RevFilter create(RevFilter[] list)

Create a filter around many filters, one of which must match.

Parameters
list:RevFilter[]

list of filters to match against. Must contain at least 2 filters.

Returns:RevFilter

a filter that must match at least one input filter.

createback to summary
public static RevFilter create(Collection<RevFilter> list)

Create a filter around many filters, one of which must match.

Parameters
list:Collection<RevFilter>

list of filters to match against. Must contain at least 2 filters.

Returns:RevFilter

a filter that must match at least one input filter.

org.eclipse.jgit.revwalk.filter back to summary

private Class OrRevFilter.Binary

extends OrRevFilter
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final RevFilter
a

private final RevFilter
b

private final boolean

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public RevFilter
clone()

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.clone.

Creates and returns a copy of this object.

public boolean
include(RevWalk
the active walker this filter is being invoked from within.
walker
,
RevCommit
the commit currently being tested. The commit has been parsed and its body is available for inspection only if the filter returns true from requiresCommitBody().
c
)

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.include.

Determine if the supplied commit should be included in results.

public boolean
requiresCommitBody()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Whether the filter needs the commit body to be parsed.

public String
toString()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.toString.

Returns a string representation of the object.

Inherited from org.eclipse.jgit.revwalk.filter.OrRevFilter:
createcreatecreate

Field Detail

aback to summary
private final RevFilter a
bback to summary
private final RevFilter b
requiresCommitBodyback to summary
private final boolean requiresCommitBody

Constructor Detail

Binaryback to summary
pack-priv Binary(RevFilter one, RevFilter two)

Method Detail

cloneback to summary
public RevFilter clone()

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.clone.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.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
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

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 revision 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:RevFilter

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
includeback to summary
public boolean include(RevWalk walker, RevCommit c) throws MissingObjectException, IncorrectObjectTypeException, IOException

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.include.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.include.

Determine if the supplied commit should be included in results.

Parameters
walker:RevWalk

the active walker this filter is being invoked from within.

c:RevCommit

the commit currently being tested. The commit has been parsed and its body is available for inspection only if the filter returns true from requiresCommitBody().

Returns:boolean

true to include this commit in the results; false to have this commit be omitted entirely from the results.

Annotations
@Override
Exceptions
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 commit 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.
requiresCommitBodyback to summary
public boolean requiresCommitBody()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Whether the filter needs the commit body to be parsed.

Returns:boolean

true if the filter needs the commit body to be parsed.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.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
@SuppressWarnings:nls
@Override
org.eclipse.jgit.revwalk.filter back to summary

private Class OrRevFilter.List

extends OrRevFilter
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final boolean
private final RevFilter[]

Constructor Summary

AccessConstructor and Description
pack-priv
List(RevFilter[] list)

Method Summary

Modifier and TypeMethod and Description
public RevFilter
clone()

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.clone.

Creates and returns a copy of this object.

public boolean
include(RevWalk
the active walker this filter is being invoked from within.
walker
,
RevCommit
the commit currently being tested. The commit has been parsed and its body is available for inspection only if the filter returns true from requiresCommitBody().
c
)

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.include.

Determine if the supplied commit should be included in results.

public boolean
requiresCommitBody()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Whether the filter needs the commit body to be parsed.

public String
toString()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.toString.

Returns a string representation of the object.

Inherited from org.eclipse.jgit.revwalk.filter.OrRevFilter:
createcreatecreate

Field Detail

requiresCommitBodyback to summary
private final boolean requiresCommitBody
subfiltersback to summary
private final RevFilter[] subfilters

Constructor Detail

Listback to summary
pack-priv List(RevFilter[] list)

Method Detail

cloneback to summary
public RevFilter clone()

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.clone.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.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
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

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 revision 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:RevFilter

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
includeback to summary
public boolean include(RevWalk walker, RevCommit c) throws MissingObjectException, IncorrectObjectTypeException, IOException

Implements abstract org.eclipse.jgit.revwalk.filter.RevFilter.include.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.include.

Determine if the supplied commit should be included in results.

Parameters
walker:RevWalk

the active walker this filter is being invoked from within.

c:RevCommit

the commit currently being tested. The commit has been parsed and its body is available for inspection only if the filter returns true from requiresCommitBody().

Returns:boolean

true to include this commit in the results; false to have this commit be omitted entirely from the results.

Annotations
@Override
Exceptions
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 commit 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.
requiresCommitBodyback to summary
public boolean requiresCommitBody()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Doc from org.eclipse.jgit.revwalk.filter.RevFilter.requiresCommitBody.

Whether the filter needs the commit body to be parsed.

Returns:boolean

true if the filter needs the commit body to be parsed.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.eclipse.jgit.revwalk.filter.RevFilter.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