Package org.springframework.aop

Interface MethodMatcher

All Known Subinterfaces:
IntroductionAwareMethodMatcher
All Known Implementing Classes:
AbstractRegexpMethodPointcut, AnnotationMethodMatcher, AspectJExpressionPointcut, ControlFlowPointcut, DynamicMethodMatcher, DynamicMethodMatcherPointcut, JCacheOperationSourcePointcut, JdkRegexpMethodPointcut, NameMatchMethodPointcut, StaticMethodMatcher, StaticMethodMatcherPointcut, StaticMethodMatcherPointcutAdvisor
public interface MethodMatcher
Part of a Pointcut: Checks whether the target method is eligible for advice.

A MethodMatcher may be evaluated statically or at runtime (dynamically). Static matching involves a method and (possibly) method attributes. Dynamic matching also makes arguments for a particular call available, and any effects of running previous advice applying to the joinpoint.

If an implementation returns false from its isRuntime() method, evaluation can be performed statically, and the result will be the same for all invocations of this method, whatever their arguments. This means that if the isRuntime() method returns false, the 3-arg matches(Method, Class, Object[]) method will never be invoked.

If an implementation returns true from its 2-arg matches(Method, Class) method and its isRuntime() method returns true, the 3-arg matches(Method, Class, Object[]) method will be invoked immediately before each potential execution of the related advice to decide whether the advice should run. All previous advice, such as earlier interceptors in an interceptor chain, will have run, so any state changes they have produced in parameters or ThreadLocal state will be available at the time of evaluation.

WARNING: Concrete implementations of this interface must provide proper implementations of Object.equals(Object), Object.hashCode(), and Object.toString() in order to allow the matcher to be used in caching scenarios — for example, in proxies generated by CGLIB. As of Spring Framework 6.0.13, the toString() implementation must generate a unique string representation that aligns with the logic used to implement equals(). See concrete implementations of this interface within the framework for examples.

Since:
11.11.2003
Author:
Rod Johnson, Sam Brannen
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MethodMatcher
    TRUE
    Canonical instance of a MethodMatcher that matches all methods.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRuntime()
    Is this MethodMatcher dynamic, that is, must a final check be made via the matches(Method, Class, Object[]) method at runtime even if matches(Method, Class) returns true?
    boolean
    matches(Method method, Class<?> targetClass)
    Perform static checking to determine whether the given method matches.
    boolean
    matches(Method method, Class<?> targetClass, Object... args)
    Check whether there is a runtime (dynamic) match for this method, which must have matched statically.

  • Field Details

    • TRUE

      static final MethodMatcher TRUE
      Canonical instance of a MethodMatcher that matches all methods.

  • Method Details

    • matches

      boolean matches(Method method, Class<?> targetClass)
      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 - the candidate method
      targetClass - the target class
      Returns:
      whether this method matches statically

    • isRuntime

      boolean isRuntime()
      Is this MethodMatcher dynamic, that is, must a final check be made via the matches(Method, Class, Object[]) method at runtime even if matches(Method, Class) returns true?

      Can be invoked when an AOP proxy is created, and need not be invoked again before each method invocation.

      Returns:
      whether a runtime match via matches(Method, Class, Object[]) is required if static matching passed

    • matches

      boolean matches(Method method, Class<?> targetClass, Object... args)
      Check whether there is a runtime (dynamic) match for this method, which must have matched statically.

      This method is invoked only if matches(Method, Class) returns true for the given method and target class, and if isRuntime() returns true.

      Invoked immediately before potential running of the advice, after any advice earlier in the advice chain has run.

      Parameters:
      method - the candidate method
      targetClass - the target class
      args - arguments to the method
      Returns:
      whether there's a runtime match
      See Also: