View Javadoc
1   /*
2    *    Copyright 2009-2023 the original author or authors.
3    *
4    *    Licensed under the Apache License, Version 2.0 (the "License");
5    *    you may not use this file except in compliance with the License.
6    *    You may obtain a copy of the License at
7    *
8    *       https://www.apache.org/licenses/LICENSE-2.0
9    *
10   *    Unless required by applicable law or agreed to in writing, software
11   *    distributed under the License is distributed on an "AS IS" BASIS,
12   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *    See the License for the specific language governing permissions and
14   *    limitations under the License.
15   */
16  package org.apache.ibatis.plugin;
17  
18  import java.lang.annotation.Documented;
19  import java.lang.annotation.ElementType;
20  import java.lang.annotation.Retention;
21  import java.lang.annotation.RetentionPolicy;
22  import java.lang.annotation.Target;
23  
24  // @formatter:off
25  /**
26   * The annotation that specify target methods to intercept.
27   * <p>
28   * <b>How to use:</b>
29   *
30   * <pre>
31   * &#064;Intercepts({ &#064;Signature(
32   *   type = Executor.class,
33   *   method = "update",
34   *   args = { MappedStatement.class, Object.class }) })
35   * public class ExamplePlugin implements Interceptor {
36   *   &#064;Override
37   *   public Object intercept(Invocation invocation) throws Throwable {
38   *     // implement pre-processing if needed
39   *     Object returnObject = invocation.proceed();
40   *     // implement post-processing if needed
41   *     return returnObject;
42   *   }
43   * }
44   * </pre>
45   *
46   * @author Clinton Begin
47   */
48  // @formatter:on
49  @Documented
50  @Retention(RetentionPolicy.RUNTIME)
51  @Target(ElementType.TYPE)
52  public @interface Intercepts {
53    /**
54     * Returns method signatures to intercept.
55     *
56     * @return method signatures
57     */
58    Signature[] value();
59  }