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.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 collections.
27 *
28 * @see Result
29 * @see Results
30 * @author Clinton Begin
31 */
32 @Documented
33 @Retention(RetentionPolicy.RUNTIME)
34 @Target({})
35 public @interface Many {
36 /**
37 * Returns the columnPrefix.
38 *
39 * @return the columnPrefix.
40 * @since 3.5.5
41 */
42 String columnPrefix() default "";
43
44 /**
45 * Returns the result map id used to map collection.
46 *
47 * @return the result map id
48 * @since 3.5.5
49 */
50 String resultMap() default "";
51
52 /**
53 * Returns the statement id that retrieves collection.
54 *
55 * @return the statement id
56 */
57 String select() default "";
58
59 /**
60 * Returns the fetch strategy for nested statement.
61 *
62 * @return the fetch strategy
63 */
64 FetchType fetchType() default FetchType.DEFAULT;
65
66 }