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