1 /**
2 * Copyright 2009-2019 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 specify result map names to use.
26 *
27 * <p><br>
28 * <b>How to use:</b><br>
29 * Mapper interface:
30 * <pre>
31 * public interface UserMapper {
32 * @Select("SELECT id, name FROM users WHERE id = #{id}")
33 * @ResultMap("userMap")
34 * User selectById(int id);
35 *
36 * @Select("SELECT u.id, u.name FROM users u INNER JOIN users_email ue ON u.id = ue.id WHERE ue.email = #{email}")
37 * @ResultMap("userMap")
38 * User selectByEmail(String email);
39 * }
40 * </pre>
41 * Mapper XML:
42 * <pre>{@code
43 * <mapper namespace="com.example.mapper.UserMapper">
44 * <resultMap id="userMap" type="com.example.model.User">
45 * <id property="id" column="id" />
46 * <result property="name" column="name" />
47 * <association property="email" select="selectUserEmailById" column="id" fetchType="lazy"/>
48 * </resultMap>
49 * </mapper>
50 * }
51 * </pre>
52 * @author Jeff Butler
53 */
54 @Documented
55 @Retention(RetentionPolicy.RUNTIME)
56 @Target(ElementType.METHOD)
57 public @interface ResultMap {
58 /**
59 * Returns result map names to use.
60 *
61 * @return result map names
62 */
63 String[] value();
64 }