Spring Framework 6.1.4 · org.springframework.aop.support.AbstractRegexpMethodPointcut

Modifier and Type	Field and Description
private String[]	excludedPatterns Regular expressions not to match.
private String[]	patterns Regular expressions to match.

Access	Constructor and Description
public	AbstractRegexpMethodPointcut()

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String[]	getExcludedPatterns() Returns the regular expressions for exclusion matching.
public String[]	getPatterns() Return the regular expressions for method matching.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected abstract void	initExcludedPatternRepresentation(String[] the patterns to initialize patterns) Subclasses must implement this to initialize regexp pointcuts.
protected abstract void	initPatternRepresentation(String[] the patterns to initialize patterns) Subclasses must implement this to initialize regexp pointcuts.
public boolean	matches(Method the candidate method method, Class<?> the target class targetClass) Implements org.springframework.aop.MethodMatcher.matches. Try to match the regular expression against the fully qualified name of the target class as well as against the method's declaring class, plus the name of the method.
protected abstract boolean	Returns: `true` if there is a match, `false` otherwise matches(String the `String` pattern to match pattern, int index of pattern (starting from 0) patternIndex) Does the pattern at the given index match the given String?
protected abstract boolean	Returns: `true` if there is a match, `false` otherwise matchesExclusion(String the `String` pattern to match pattern, int index of pattern (starting from 0) patternIndex) Does the exclusion pattern at the given index match the given String?
protected boolean	Returns: whether the candidate matches at least one of the specified patterns matchesPattern(String "java.lang.Object.hashCode" style signature signatureString) Match the specified candidate against the configured patterns.
public void	setExcludedPattern(String excludedPattern) Convenience method when we have only a single exclusion pattern.
public void	setExcludedPatterns(String... excludedPatterns) Set the regular expressions defining methods to match for exclusion.
public void	setPattern(String pattern) Convenience method when we have only a single pattern.
public void	setPatterns(String... patterns) Set the regular expressions defining methods to match.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.springframework.aop.support.StaticMethodMatcherPointcut:: getClassFilter getMethodMatcher setClassFilter

excludedPatterns	back to summary
private String[] excludedPatterns Regular expressions not to match.

patterns	back to summary
private String[] patterns Regular expressions to match.

AbstractRegexpMethodPointcut	back to summary
public AbstractRegexpMethodPointcut()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getExcludedPatterns	back to summary
public String[] getExcludedPatterns() Returns the regular expressions for exclusion matching.

getPatterns	back to summary
public String[] getPatterns() Return the regular expressions for method matching.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

initExcludedPatternRepresentation back to summary

initExcludedPatternRepresentation	back to summary
protected abstract void initExcludedPatternRepresentation(String[] patterns) throws IllegalArgumentException Subclasses must implement this to initialize regexp pointcuts. Can be invoked multiple times. This method will be invoked from the `setExcludedPatterns` method, and also on deserialization. Parameters patterns:String[] the patterns to initialize Exceptions IllegalArgumentException: in case of an invalid pattern

protected abstract void initExcludedPatternRepresentation(String[] patterns) throws IllegalArgumentException

Subclasses must implement this to initialize regexp pointcuts. Can be invoked multiple times.

This method will be invoked from the setExcludedPatterns method, and also on deserialization.

Parameters

patterns:String[]: the patterns to initialize

Exceptions

IllegalArgumentException:: in case of an invalid pattern

initPatternRepresentation back to summary

initPatternRepresentation	back to summary
protected abstract void initPatternRepresentation(String[] patterns) throws IllegalArgumentException Subclasses must implement this to initialize regexp pointcuts. Can be invoked multiple times. This method will be invoked from the `setPatterns` method, and also on deserialization. Parameters patterns:String[] the patterns to initialize Exceptions IllegalArgumentException: in case of an invalid pattern

protected abstract void initPatternRepresentation(String[] patterns) throws IllegalArgumentException

Subclasses must implement this to initialize regexp pointcuts. Can be invoked multiple times.

This method will be invoked from the setPatterns method, and also on deserialization.

Parameters

patterns:String[]: the patterns to initialize

Exceptions

IllegalArgumentException:: in case of an invalid pattern

matches	back to summary
public boolean matches(Method method, Class<?> targetClass) Implements org.springframework.aop.MethodMatcher.matches. Try to match the regular expression against the fully qualified name of the target class as well as against the method's declaring class, plus the name of the method. Parameters method:Method Doc from org.springframework.aop.MethodMatcher.matches. the candidate method targetClass:Class<?> Doc from org.springframework.aop.MethodMatcher.matches. the target class Returns:boolean Doc from org.springframework.aop.MethodMatcher.matches. whether this method matches statically Annotations @Override

matches

back to summary

public boolean matches(Method method, Class<?> targetClass)

Implements org.springframework.aop.MethodMatcher.matches.

Try to match the regular expression against the fully qualified name of the target class as well as against the method's declaring class, plus the name of the method.

Parameters

method:Method

Doc from org.springframework.aop.MethodMatcher.matches.

the candidate method

targetClass:Class<?>

Doc from org.springframework.aop.MethodMatcher.matches.

the target class

Returns:boolean

Doc from org.springframework.aop.MethodMatcher.matches.

whether this method matches statically

Annotations

@Override

matches back to summary

matches	back to summary
protected abstract boolean matches(String pattern, int patternIndex) Does the pattern at the given index match the given String? Parameters pattern:String the `String` pattern to match patternIndex:int index of pattern (starting from 0) Returns:boolean `true` if there is a match, `false` otherwise

protected abstract boolean matches(String pattern, int patternIndex)

Does the pattern at the given index match the given String?

Parameters

pattern:String: the String pattern to match
patternIndex:int: index of pattern (starting from 0)

Returns:boolean

true if there is a match, false otherwise

matchesExclusion back to summary

matchesExclusion	back to summary
protected abstract boolean matchesExclusion(String pattern, int patternIndex) Does the exclusion pattern at the given index match the given String? Parameters pattern:String the `String` pattern to match patternIndex:int index of pattern (starting from 0) Returns:boolean `true` if there is a match, `false` otherwise

protected abstract boolean matchesExclusion(String pattern, int patternIndex)

Does the exclusion pattern at the given index match the given String?

Parameters

pattern:String: the String pattern to match
patternIndex:int: index of pattern (starting from 0)

Returns:boolean

true if there is a match, false otherwise

matchesPattern	back to summary
protected boolean matchesPattern(String signatureString) Match the specified candidate against the configured patterns. Parameters signatureString:String "java.lang.Object.hashCode" style signature Returns:boolean whether the candidate matches at least one of the specified patterns

matchesPattern

back to summary

protected boolean matchesPattern(String signatureString)

Match the specified candidate against the configured patterns.

Parameters

signatureString:String: "java.lang.Object.hashCode" style signature

Returns:boolean

whether the candidate matches at least one of the specified patterns

setExcludedPattern back to summary

setExcludedPattern	back to summary
public void setExcludedPattern(String excludedPattern) Convenience method when we have only a single exclusion pattern. Use either this method or `setExcludedPatterns`, not both. See Also `setExcludedPatterns`

public void setExcludedPattern(String excludedPattern)

Convenience method when we have only a single exclusion pattern. Use either this method or setExcludedPatterns, not both.

See Also: setExcludedPatterns

setExcludedPatterns back to summary

setExcludedPatterns	back to summary
public void setExcludedPatterns(String... excludedPatterns) Set the regular expressions defining methods to match for exclusion. Matching will be the union of all these; if any match, the pointcut matches. See Also `setExcludedPattern`

public void setExcludedPatterns(String... excludedPatterns)

Set the regular expressions defining methods to match for exclusion. Matching will be the union of all these; if any match, the pointcut matches.

See Also: setExcludedPattern

setPattern back to summary

setPattern	back to summary
public void setPattern(String pattern) Convenience method when we have only a single pattern. Use either this method or `setPatterns`, not both. See Also `setPatterns`

public void setPattern(String pattern)

Convenience method when we have only a single pattern. Use either this method or setPatterns, not both.

See Also: setPatterns

setPatterns back to summary

setPatterns	back to summary
public void setPatterns(String... patterns) Set the regular expressions defining methods to match. Matching will be the union of all these; if any match, the pointcut matches. See Also `setPattern`

public void setPatterns(String... patterns)

Set the regular expressions defining methods to match. Matching will be the union of all these; if any match, the pointcut matches.

See Also: setPattern

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

public abstract Class AbstractRegexpMethodPointcut

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail