JGit 7.2.0.202503040940-r · org.eclipse.jgit.revwalk.filter.SubStringRevFilter

Modifier and Type	Field and Description
private final RawSubStringPattern	pattern

Access	Constructor and Description
protected	SubStringRevFilter(String text to locate. This should be a safe string as described by the `safe(String)` as regular expression meta characters are treated as literals. patternText) Construct a new matching filter.

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()`. cmit) 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 static boolean	Returns: true if a substring filter can perform this pattern match; false if `org.eclipse.jgit.revwalk.filter.PatternMatchRevFilter` must be used instead. safe(String the pattern text proposed by the user. pattern) Can this string be safely handled by a substring filter?
protected abstract RawCharSequence	Returns: sequence for the commit's content that we need to match on. text(RevCommit current commit being evaluated. cmit) Obtain the raw text to match against.
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

pattern	back to summary
private final RawSubStringPattern pattern

SubStringRevFilter	back to summary
protected SubStringRevFilter(String patternText) Construct a new matching filter. Parameters patternText:String text to locate. This should be a safe string as described by the `safe(String)` as regular expression meta characters are treated as literals.

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.

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

include back to summary

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

public boolean include(RevWalk walker, RevCommit cmit) 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.
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.

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.

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

safe back to summary

safe	back to summary
public static boolean safe(String pattern) Can this string be safely handled by a substring filter? Parameters pattern:String the pattern text proposed by the user. Returns:boolean true if a substring filter can perform this pattern match; false if `org.eclipse.jgit.revwalk.filter.PatternMatchRevFilter` must be used instead.

public static boolean safe(String pattern)

Can this string be safely handled by a substring filter?

Parameters

pattern:String: the pattern text proposed by the user.

Returns:boolean

true if a substring filter can perform this pattern match; false if org.eclipse.jgit.revwalk.filter.PatternMatchRevFilter must be used instead.

text	back to summary
protected abstract RawCharSequence text(RevCommit cmit) Obtain the raw text to match against. Parameters cmit:RevCommit current commit being evaluated. Returns:RawCharSequence sequence for the commit's content that we need to match on.

text

back to summary

protected abstract RawCharSequence text(RevCommit cmit)

Obtain the raw text to match against.

Parameters

cmit:RevCommit: current commit being evaluated.

Returns:RawCharSequence

sequence for the commit's content that we need to match on.

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 @SuppressWarnings:nls @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

@SuppressWarnings:nls
@Override

public abstract Class SubStringRevFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail