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

public Class AnnotationMethodMatcher

extends StaticMethodMatcher
Class Inheritance
Imports
java.lang.annotation.Annotation, java.lang.reflect.Method, .Proxy, org.springframework.aop.support.AopUtils, .StaticMethodMatcher, org.springframework.core.annotation.AnnotatedElementUtils, org.springframework.lang.Nullable, org.springframework.util.Assert
Simple MethodMatcher that looks for a specific annotation being present on a method (checking both the method on the invoked interface, if any, and the corresponding method on the target class).
Authors
Juergen Hoeller, Sam Brannen
Since
2.0
See Also
AnnotationMatchingPointcut

Field Summary

Modifier and TypeField and Description
private final Class<? extends Annotation>
annotationType

private final boolean
checkInherited

Constructor Summary

AccessConstructor and Description
public
AnnotationMethodMatcher(Class<? extends Annotation>
the annotation type to look for
annotationType)

Create a new AnnotationClassFilter for the given annotation type.

public
AnnotationMethodMatcher(Class<? extends Annotation>
the annotation type to look for
annotationType, boolean
whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type (i.e. whether to use AnnotatedElementUtils#hasAnnotation semantics instead of standard Java Method#isAnnotationPresent)
checkInherited)

Create a new AnnotationClassFilter for the given annotation type.

Method Summary

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

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

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.

private boolean
matchesMethod(Method method)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.springframework.aop.support.StaticMethodMatcher:
isRuntimematches

Field Detail

annotationTypeback to summary
private final Class<? extends Annotation> annotationType
checkInheritedback to summary
private final boolean checkInherited

Constructor Detail

AnnotationMethodMatcherback to summary
public AnnotationMethodMatcher(Class<? extends Annotation> annotationType)

Create a new AnnotationClassFilter for the given annotation type.

Parameters
annotationType:Class<? extends Annotation>

the annotation type to look for

AnnotationMethodMatcherback to summary
public AnnotationMethodMatcher(Class<? extends Annotation> annotationType, boolean checkInherited)

Create a new AnnotationClassFilter for the given annotation type.

Parameters
annotationType:Class<? extends Annotation>

the annotation type to look for

checkInherited:boolean

whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type (i.e. whether to use AnnotatedElementUtils#hasAnnotation semantics instead of standard Java Method#isAnnotationPresent)

Since
5.0

Method Detail

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 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
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
matchesMethodback to summary
private boolean matchesMethod(Method method)
toStringback 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