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