Top Description Fields Constructors Methods
org.springframework.aop.support

public Class NameMatchMethodPointcut

extends StaticMethodMatcherPointcut
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, java.lang.reflect.Method, java.util.ArrayList, .Arrays, .List, org.springframework.lang.Nullable, org.springframework.util.PatternMatchUtils
Pointcut bean for simple method name matches, as an alternative to regular expression patterns.

Each configured method name can be an exact method name or a method name pattern (see isMatch(String, String) for details on the supported pattern styles).

Does not handle overloaded methods: all methods with a given name will be eligible.

Authors
Juergen Hoeller, Rod Johnson, Rob Harrop, Sam Brannen
Since
11.02.2004
See Also
isMatch, JdkRegexpMethodPointcut

Field Summary

Modifier and TypeField and Description
private List<String>
mappedNamePatterns

Constructor Summary

AccessConstructor and Description
public
NameMatchMethodPointcut()

Method Summary

Modifier and TypeMethod and Description
public NameMatchMethodPointcut

Returns:

this pointcut to allow for method chaining
addMethodName(String
the additional method name pattern
mappedNamePattern)

Add another method name pattern, in addition to those already configured.

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 int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
protected boolean

Returns:

true if the method name matches the pattern
isMatch(String
the method name to check
methodName, String
the method name pattern
mappedNamePattern)

Determine if the given method name matches the mapped name pattern.

public boolean
matches(Method
the candidate method
method, Class<?>
the target class
targetClass)

Implements org.springframework.aop.MethodMatcher.matches.

Perform static checking to determine whether the given method matches.
public void
setMappedName(String mappedNamePattern)

Convenience method for configuring a single method name pattern.

public void
setMappedNames(String... mappedNamePatterns)

Set the method name patterns 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:
getClassFiltergetMethodMatchersetClassFilter

Field Detail

mappedNamePatternsback to summary
private List<String> mappedNamePatterns

Constructor Detail

NameMatchMethodPointcutback to summary
public NameMatchMethodPointcut()

Method Detail

addMethodNameback to summary
public NameMatchMethodPointcut addMethodName(String mappedNamePattern)

Add another method name pattern, in addition to those already configured.

Like the "set" methods, this method is for use when configuring proxies, before a proxy is used.

Note

This method does not work after the proxy is in use, since advice chains will be cached.

Parameters
mappedNamePattern:String

the additional method name pattern

Returns:NameMatchMethodPointcut

this pointcut to allow for method chaining

See Also
setMappedNames(String...), setMappedName(String)
equalsback 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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
isMatchback to summary
protected boolean isMatch(String methodName, String mappedNamePattern)

Determine if the given method name matches the mapped name pattern.

The default implementation checks for xxx*, *xxx, *xxx*, and xxx*yyy matches, as well as direct equality.

Can be overridden in subclasses.

Parameters
methodName:String

the method name to check

mappedNamePattern:String

the method name pattern

Returns:boolean

true if the method name matches the pattern

See Also
PatternMatchUtils#simpleMatch(String, String)
matchesback to summary
public boolean matches(Method method, Class<?> targetClass)

Implements org.springframework.aop.MethodMatcher.matches.

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

Perform static checking to determine whether the given method matches.

If this method returns false or if isRuntime() returns false, no runtime check (i.e. no matches(Method, Class, Object[]) call) will be made.

Parameters
method:Method

the candidate method

targetClass:Class<?>

the target class

Returns:boolean

whether this method matches statically

Annotations
@Override
setMappedNameback to summary
public void setMappedName(String mappedNamePattern)

Convenience method for configuring a single method name pattern.

Use either this method or setMappedNames(String...), but not both.

See Also
setMappedNames
setMappedNamesback to summary
public void setMappedNames(String... mappedNamePatterns)

Set the method name patterns defining methods to match.

Matching will be the union of all these; if any match, the pointcut matches.

See Also
setMappedName(String)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override