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.Retention;
20  import java.lang.annotation.RetentionPolicy;
21  import java.lang.annotation.Target;
22  
23  import org.apache.ibatis.mapping.FetchType;
24  
25  /**
26   * The annotation that specify the nested statement for retrieving single object.
27   *
28   * @see Result
29   * @see Results
30   *
31   * @author Clinton Begin
32   */
33  @Documented
34  @Retention(RetentionPolicy.RUNTIME)
35  @Target({})
36  public @interface One {
37    /**
38     * Returns the columnPrefix.
39     *
40     * @return the columnPrefix.
41     *
42     * @since 3.5.5
43     */
44    String columnPrefix() default "";
45  
46    /**
47     * Returns the result map id used to map single object.
48     *
49     * @return the result map id
50     *
51     * @since 3.5.5
52     */
53    String resultMap() default "";
54  
55    /**
56     * Returns the statement id that retrieves single object.
57     *
58     * @return the statement id
59     */
60    String select() default "";
61  
62    /**
63     * Returns the fetch strategy for nested statement.
64     *
65     * @return the fetch strategy
66     */
67    FetchType fetchType() default FetchType.DEFAULT;
68  
69  }