1 /*
2 * Copyright 2009-2021 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 * http://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 /**
25 * The annotation that specify target methods to intercept.
26 *
27 * <b>How to use:</b>
28 * <pre>
29 * @Intercepts({@Signature(
30 * type= Executor.class,
31 * method = "update",
32 * args = {MappedStatement.class ,Object.class})})
33 * public class ExamplePlugin implements Interceptor {
34 * @Override
35 * public Object intercept(Invocation invocation) throws Throwable {
36 * // implement pre-processing if needed
37 * Object returnObject = invocation.proceed();
38 * // implement post-processing if needed
39 * return returnObject;
40 * }
41 * }
42 * </pre>
43 * @author Clinton Begin
44 */
45 @Documented
46 @Retention(RetentionPolicy.RUNTIME)
47 @Target(ElementType.TYPE)
48 public @interface Intercepts {
49 /**
50 * Returns method signatures to intercept.
51 *
52 * @return method signatures
53 */
54 Signature[] value();
55 }
56