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.annotations;
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 be grouping mapping definitions for constructor.
26 *
27 * <p>
28 * <b>How to use:</b>
29 *
30 * <pre>
31 * public interface UserMapper {
32 * @ConstructorArgs({
33 * @Arg(column = "id", javaType = int.class, id = true),
34 * @Arg(column = "name", javaType = String.class),
35 * @Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id")
36 * })
37 * @Select("SELECT id, name FROM users WHERE id = #{id}")
38 * User selectById(int id);
39 * }
40 * </pre>
41 *
42 * @author Clinton Begin
43 */
44 @Documented
45 @Retention(RetentionPolicy.RUNTIME)
46 @Target(ElementType.METHOD)
47 public @interface ConstructorArgs {
48 /**
49 * Returns mapping definitions for constructor.
50 *
51 * @return mapping definitions
52 */
53 Arg[] value() default {};
54 }