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 /**
25 * The marker annotation that indicate a constructor for automatic mapping.
26 * <p>
27 * <b>How to use:</b>
28 *
29 * <pre>
30 * public class User {
31 *
32 * private int id;
33 * private String name;
34 *
35 * public User(int id) {
36 * this.id = id;
37 * }
38 *
39 * @AutomapConstructor
40 * public User(int id, String name) {
41 * this.id = id;
42 * this.name = name;
43 * }
44 * // ...
45 * }
46 * </pre>
47 *
48 * @author Tim Chen
49 *
50 * @since 3.4.3
51 */
52 @Documented
53 @Retention(RetentionPolicy.RUNTIME)
54 @Target({ ElementType.CONSTRUCTOR })
55 public @interface AutomapConstructor {
56 }