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 property.
26 *
27 * <p>
28 * <b>How to use:</b>
29 *
30 * <pre>
31 * public interface UserMapper {
32 * @Results({
33 * @Result(property = "id", column = "id", id = true),
34 * @Result(property = "name", column = "name"),
35 * @Result(property = "email" column = "id", one = @One(select = "selectUserEmailById", fetchType = FetchType.LAZY)),
36 * @Result(property = "telephoneNumbers" column = "id", many = @Many(select = "selectAllUserTelephoneNumberById", fetchType = FetchType.LAZY))
37 * })
38 * @Select("SELECT id, name FROM users WHERE id = #{id}")
39 * User selectById(int id);
40 * }
41 * </pre>
42 *
43 * @author Clinton Begin
44 */
45 @Documented
46 @Retention(RetentionPolicy.RUNTIME)
47 @Target(ElementType.METHOD)
48 public @interface Results {
49 /**
50 * Returns the id of this result map.
51 *
52 * @return the id of this result map
53 */
54 String id() default "";
55
56 /**
57 * Returns mapping definitions for property.
58 *
59 * @return mapping definitions
60 */
61 Result[] value() default {};
62 }