Selects interesting revisions during walking.

This is an abstract interface. Applications may implement a subclass, or use one of the predefined implementations already available within this package. Filters may be chained together using AndRevFilter and OrRevFilter to create complex boolean expressions.

Applications should install the filter on a RevWalk by org.eclipse.jgit.revwalk.RevWalk#setRevFilter(RevFilter) prior to starting traversal.

Unless specifically noted otherwise a RevFilter implementation is not thread safe and may not be shared by different RevWalk instances at the same time. This restriction allows RevFilter implementations to cache state within their instances during include(RevWalk, RevCommit) if it is beneficial to their implementation. Deep clones created by clone() may be used to construct a thread-safe copy of an existing filter.

Message filters:

Author name/email: org.eclipse.jgit.revwalk.filter.AuthorRevFilter
Committer name/email: org.eclipse.jgit.revwalk.filter.CommitterRevFilter
Message body: org.eclipse.jgit.revwalk.filter.MessageRevFilter

Merge filters:

Skip all merges: NO_MERGES.
Skip all non-merges: ONLY_MERGES

Boolean modifiers:

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	RevFilter.AllFilter
private static class	RevFilter.MergeBaseFilter
private static class	RevFilter.NoMergesFilter
private static class	RevFilter.NoneFilter
private static class	RevFilter.OnlyMergesFilter

Modifier and Type	Field and Description
public static final RevFilter	ALL Default filter that always returns true (thread safe).
public static final RevFilter	MERGE_BASE Selects only merge bases of the starting points (thread safe).
public static final RevFilter	NO_MERGES Excludes commits with more than one parent (thread safe).
public static final RevFilter	NONE Default filter that always returns false (thread safe).
public static final RevFilter	ONLY_MERGES Filter including only merge commits, excluding all commits with less than two parents (thread safe).

Access	Constructor and Description
public	RevFilter()

Method Summary

Modifier and Type	Method and Description
public abstract RevFilter	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public abstract boolean	Returns: true to include this commit in the results; false to have this commit be omitted entirely from the results. 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()`. cmit) Determine if the supplied commit should be included in results.
public RevFilter	Returns: a new filter that includes commits this filter rejects. negate() Create a new filter that does the opposite of this filter.
public boolean	Returns: true if the filter needs the commit body to be parsed. requiresCommitBody() Whether the filter needs the commit body to be parsed.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

ALL	back to summary
public static final RevFilter ALL Default filter that always returns true (thread safe).

MERGE_BASE	back to summary
public static final RevFilter MERGE_BASE Selects only merge bases of the starting points (thread safe). This is a special case filter that cannot be combined with any other filter. Its include method always throws an exception as context information beyond the arguments is necessary to determine if the supplied commit is a merge base.

NO_MERGES	back to summary
public static final RevFilter NO_MERGES Excludes commits with more than one parent (thread safe).

NONE	back to summary
public static final RevFilter NONE Default filter that always returns false (thread safe).

ONLY_MERGES	back to summary
public static final RevFilter ONLY_MERGES Filter including only merge commits, excluding all commits with less than two parents (thread safe). Since 4.4

RevFilter	back to summary
public RevFilter()

Method Detail

clone back to summary

clone	back to summary
public abstract RevFilter clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.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 a clone of this instance. Annotations @Override

public abstract RevFilter clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.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

a clone of this instance.

Annotations

@Override

include back to summary

include	back to summary
public abstract boolean include(RevWalk walker, RevCommit cmit) throws StopWalkException, MissingObjectException, IncorrectObjectTypeException, IOException Determine if the supplied commit should be included in results. Parameters walker:RevWalk the active walker this filter is being invoked from within. cmit: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. Exceptions StopWalkException: the filter knows for certain that no additional commits can ever match, and the current commit doesn't match either. The walk is halted and no more results are provided. 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.

public abstract boolean include(RevWalk walker, RevCommit cmit) throws StopWalkException, MissingObjectException, IncorrectObjectTypeException, IOException

Determine if the supplied commit should be included in results.

Parameters

walker:RevWalk: the active walker this filter is being invoked from within.
cmit: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.

Exceptions

StopWalkException:: the filter knows for certain that no additional commits can ever match, and the current commit doesn't match either. The walk is halted and no more results are provided.
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.

negate	back to summary
public RevFilter negate() Create a new filter that does the opposite of this filter. Returns:RevFilter a new filter that includes commits this filter rejects.

negate

back to summary

public RevFilter negate()

Create a new filter that does the opposite of this filter.

Returns:RevFilter: a new filter that includes commits this filter rejects.

requiresCommitBody	back to summary
public boolean requiresCommitBody() Whether the filter needs the commit body to be parsed. Returns:boolean true if the filter needs the commit body to be parsed.

requiresCommitBody

back to summary

public boolean requiresCommitBody()

Whether the filter needs the commit body to be parsed.

Returns:boolean: true if the filter needs the commit body to be parsed.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.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

public String toString()

Overrides java.lang.Object.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

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

private final Class RevFilter.AllFilter

Class Inheritance

extends RevFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.RevFilter
org.eclipse.jgit.revwalk.filter.RevFilter.AllFilter

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:: ALL MERGE_BASE NO_MERGES NONE ONLY_MERGES

Constructor Summary

Access	Constructor and Description
private	AllFilter()

Method Summary

Modifier and Type	Method 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.RevFilter:: negate

Constructor Detail

AllFilter	back to summary
private AllFilter()

Method Detail

clone back to summary

clone	back 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

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.

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

include back to summary

include	back to summary
public boolean include(RevWalk walker, RevCommit c) 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

public boolean include(RevWalk walker, RevCommit c)

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

requiresCommitBody	back 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

requiresCommitBody

back 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

toString back to summary

toString	back 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

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

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

private final Class RevFilter.MergeBaseFilter

Class Inheritance

extends RevFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.RevFilter
org.eclipse.jgit.revwalk.filter.RevFilter.MergeBaseFilter

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:: ALL MERGE_BASE NO_MERGES NONE ONLY_MERGES

Constructor Summary

Access	Constructor and Description
private	MergeBaseFilter()

Method Summary

Modifier and Type	Method 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.RevFilter:: negate

Constructor Detail

MergeBaseFilter	back to summary
private MergeBaseFilter()

Method Detail

clone back to summary

clone	back 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

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.

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

include back to summary

include	back to summary
public boolean include(RevWalk walker, RevCommit c) 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

public boolean include(RevWalk walker, RevCommit c)

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

requiresCommitBody	back 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

requiresCommitBody

back 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

toString back to summary

toString	back 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

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

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

private final Class RevFilter.NoMergesFilter

Class Inheritance

extends RevFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.RevFilter
org.eclipse.jgit.revwalk.filter.RevFilter.NoMergesFilter

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:: ALL MERGE_BASE NO_MERGES NONE ONLY_MERGES

Constructor Summary

Access	Constructor and Description
private	NoMergesFilter()

Method Summary

Modifier and Type	Method 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.RevFilter:: negate

Constructor Detail

NoMergesFilter	back to summary
private NoMergesFilter()

Method Detail

clone back to summary

clone	back 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

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.

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

include back to summary

include	back to summary
public boolean include(RevWalk walker, RevCommit c) 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

public boolean include(RevWalk walker, RevCommit c)

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

requiresCommitBody	back 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

requiresCommitBody

back 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

toString back to summary

toString	back 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

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

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

private final Class RevFilter.NoneFilter

Class Inheritance

extends RevFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.RevFilter
org.eclipse.jgit.revwalk.filter.RevFilter.NoneFilter

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:: ALL MERGE_BASE NO_MERGES NONE ONLY_MERGES

Constructor Summary

Access	Constructor and Description
private	NoneFilter()

Method Summary

Modifier and Type	Method 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.RevFilter:: negate

Constructor Detail

NoneFilter	back to summary
private NoneFilter()

Method Detail

clone back to summary

clone	back 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

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.

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

include back to summary

include	back to summary
public boolean include(RevWalk walker, RevCommit c) 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

public boolean include(RevWalk walker, RevCommit c)

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

requiresCommitBody	back 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

requiresCommitBody

back 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

toString back to summary

toString	back 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

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

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

private final Class RevFilter.OnlyMergesFilter

Class Inheritance

extends RevFilter

java.lang.Object
org.eclipse.jgit.revwalk.filter.RevFilter
org.eclipse.jgit.revwalk.filter.RevFilter.OnlyMergesFilter

Field Summary

Inherited from org.eclipse.jgit.revwalk.filter.RevFilter:: ALL MERGE_BASE NO_MERGES NONE ONLY_MERGES

Constructor Summary

Access	Constructor and Description
private	OnlyMergesFilter()

Method Summary

Modifier and Type	Method 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.RevFilter:: negate

Constructor Detail

OnlyMergesFilter	back to summary
private OnlyMergesFilter()

Method Detail

clone back to summary

clone	back 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

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.

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

include back to summary

include	back to summary
public boolean include(RevWalk walker, RevCommit c) 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

public boolean include(RevWalk walker, RevCommit c)

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

requiresCommitBody	back 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

requiresCommitBody

back 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

toString back to summary

toString	back 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

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

public abstract Class RevFilter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class RevFilter.AllFilter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class RevFilter.MergeBaseFilter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class RevFilter.NoMergesFilter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class RevFilter.NoneFilter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class RevFilter.OnlyMergesFilter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail