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 * This annotation can be used when a @Select method is using a
26 * ResultHandler. Those methods must have void return type, so
27 * this annotation can be used to tell MyBatis what kind of object
28 * it should build for each row.
29 *
30 * <p>
31 * <b>How to use:</b>
32 *
33 * <pre>
34 * public interface UserMapper {
35 * @ResultType(User.class)
36 * @Select("SELECT id, name FROM users WHERE name LIKE #{name} || '%' ORDER BY id")
37 * void collectByStartingWithName(String name, ResultHandler<User> handler);
38 * }
39 * </pre>
40 *
41 * @since 3.2.0
42 * @author Jeff Butler
43 */
44 @Documented
45 @Retention(RetentionPolicy.RUNTIME)
46 @Target(ElementType.METHOD)
47 public @interface ResultType {
48 /**
49 * Returns the return type.
50 *
51 * @return the return type
52 */
53 Class<?> value();
54 }