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

public Class AnnotationMatchingPointcut

extends Object
implements Pointcut
Class Inheritance
All Implemented Interfaces
org.springframework.aop.Pointcut
Imports
java.lang.annotation.Annotation, org.springframework.aop.ClassFilter, .MethodMatcher, .Pointcut, org.springframework.core.annotation.AnnotationUtils, org.springframework.lang.Nullable, org.springframework.util.Assert

Simple Pointcut that looks for a specific annotation being present on a class or method.
Authors
Juergen Hoeller, Sam Brannen
Since
2.0
See Also
AnnotationClassFilter, AnnotationMethodMatcher

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
AnnotationMatchingPointcut.AnnotationCandidateClassFilter

ClassFilter that delegates to AnnotationUtils#isCandidateClass for filtering classes whose methods are not worth searching to begin with.

Field Summary

Modifier and TypeField and Description
private final ClassFilter
private final MethodMatcher

Constructor Summary

AccessConstructor and Description
public
AnnotationMatchingPointcut(Class<? extends Annotation>
the annotation type to look for at the class level
classAnnotationType
)

Create a new AnnotationMatchingPointcut for the given annotation type.

public
AnnotationMatchingPointcut(Class<? extends Annotation>
the annotation type to look for at the class level
classAnnotationType
,
boolean
whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type
checkInherited
)

Create a new AnnotationMatchingPointcut for the given annotation type.

public
AnnotationMatchingPointcut(Class<? extends Annotation>
the annotation type to look for at the class level (can be null)
classAnnotationType
,
Class<? extends Annotation>
the annotation type to look for at the method level (can be null)
methodAnnotationType
)

Create a new AnnotationMatchingPointcut for the given annotation types.

public
AnnotationMatchingPointcut(Class<? extends Annotation>
the annotation type to look for at the class level (can be null)
classAnnotationType
,
Class<? extends Annotation>
the annotation type to look for at the method level (can be null)
methodAnnotationType
,
boolean
whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type
checkInherited
)

Create a new AnnotationMatchingPointcut for the given annotation types.

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 static AnnotationMatchingPointcut

Returns:

the corresponding AnnotationMatchingPointcut
forClassAnnotation
(Class<? extends Annotation>
the annotation type to look for at the class level
annotationType
)

Factory method for an AnnotationMatchingPointcut that matches for the specified annotation at the class level.

public static AnnotationMatchingPointcut

Returns:

the corresponding AnnotationMatchingPointcut
forMethodAnnotation
(Class<? extends Annotation>
the annotation type to look for at the method level
annotationType
)

Factory method for an AnnotationMatchingPointcut that matches for the specified annotation at the method level.

public ClassFilter
getClassFilter()

Implements org.springframework.aop.Pointcut.getClassFilter.

Return the ClassFilter for this pointcut.
public MethodMatcher
getMethodMatcher()

Implements org.springframework.aop.Pointcut.getMethodMatcher.

Return the MethodMatcher for this pointcut.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

classFilterback to summary
private final ClassFilter classFilter
methodMatcherback to summary
private final MethodMatcher methodMatcher

Constructor Detail

AnnotationMatchingPointcutback to summary
public AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType)

Create a new AnnotationMatchingPointcut for the given annotation type.

Parameters
classAnnotationType:Class<? extends Annotation>

the annotation type to look for at the class level

AnnotationMatchingPointcutback to summary
public AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType, boolean checkInherited)

Create a new AnnotationMatchingPointcut for the given annotation type.

Parameters
classAnnotationType:Class<? extends Annotation>

the annotation type to look for at the class level

checkInherited:boolean

whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type

See Also
AnnotationClassFilter#AnnotationClassFilter(Class, boolean)
AnnotationMatchingPointcutback to summary
public AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType)

Create a new AnnotationMatchingPointcut for the given annotation types.

Parameters
classAnnotationType:Class<? extends Annotation>

the annotation type to look for at the class level (can be null)

methodAnnotationType:Class<? extends Annotation>

the annotation type to look for at the method level (can be null)

AnnotationMatchingPointcutback to summary
public AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType, Class<? extends Annotation> methodAnnotationType, boolean checkInherited)

Create a new AnnotationMatchingPointcut for the given annotation types.

Parameters
classAnnotationType:Class<? extends Annotation>

the annotation type to look for at the class level (can be null)

methodAnnotationType:Class<? extends Annotation>

the annotation type to look for at the method level (can be null)

checkInherited:boolean

whether to also check the superclasses and interfaces as well as meta-annotations for the annotation type

Since
5.0
See Also
AnnotationClassFilter#AnnotationClassFilter(Class, boolean), AnnotationMethodMatcher#AnnotationMethodMatcher(Class, boolean)

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
forClassAnnotationback to summary
public static AnnotationMatchingPointcut forClassAnnotation(Class<? extends Annotation> annotationType)

Factory method for an AnnotationMatchingPointcut that matches for the specified annotation at the class level.

Parameters
annotationType:Class<? extends Annotation>

the annotation type to look for at the class level

Returns:AnnotationMatchingPointcut

the corresponding AnnotationMatchingPointcut

forMethodAnnotationback to summary
public static AnnotationMatchingPointcut forMethodAnnotation(Class<? extends Annotation> annotationType)

Factory method for an AnnotationMatchingPointcut that matches for the specified annotation at the method level.

Parameters
annotationType:Class<? extends Annotation>

the annotation type to look for at the method level

Returns:AnnotationMatchingPointcut

the corresponding AnnotationMatchingPointcut

getClassFilterback to summary
public ClassFilter getClassFilter()

Implements org.springframework.aop.Pointcut.getClassFilter.

Doc from org.springframework.aop.Pointcut.getClassFilter.

Return the ClassFilter for this pointcut.

Returns:ClassFilter

the ClassFilter (never null)

Annotations
@Override
getMethodMatcherback to summary
public MethodMatcher getMethodMatcher()

Implements org.springframework.aop.Pointcut.getMethodMatcher.

Doc from org.springframework.aop.Pointcut.getMethodMatcher.

Return the MethodMatcher for this pointcut.

Returns:MethodMatcher

the MethodMatcher (never null)

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
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
org.springframework.aop.support.annotation back to summary

private Class AnnotationMatchingPointcut.AnnotationCandidateClassFilter

extends Object
implements ClassFilter
Class Inheritance
  • java.lang.Object
  • org.springframework.aop.support.annotation.AnnotationMatchingPointcut.AnnotationCandidateClassFilter
All Implemented Interfaces
org.springframework.aop.ClassFilter

ClassFilter that delegates to AnnotationUtils#isCandidateClass for filtering classes whose methods are not worth searching to begin with.
Since
5.2

Field Summary

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

Constructor Summary

AccessConstructor and Description
pack-priv
AnnotationCandidateClassFilter(Class<? extends Annotation> annotationType)

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 the object.
public boolean
matches(Class<?>
the candidate target class
clazz
)

Implements org.springframework.aop.ClassFilter.matches.

Should the pointcut apply to the given interface or target class?
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

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

Constructor Detail

AnnotationCandidateClassFilterback to summary
pack-priv AnnotationCandidateClassFilter(Class<? extends Annotation> annotationType)

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 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
matchesback to summary
public boolean matches(Class<?> clazz)

Implements org.springframework.aop.ClassFilter.matches.

Doc from org.springframework.aop.ClassFilter.matches.

Should the pointcut apply to the given interface or target class?

Parameters
clazz:Class<?>

the candidate target class

Returns:boolean

whether the advice should apply to the given target class

Annotations
@Override
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