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 import org.apache.ibatis.scripting.LanguageDriver;
25
26 /**
27 * The annotation that specify a {@link LanguageDriver} to use.
28 *
29 * <p>
30 * <b>How to use:</b>
31 *
32 * <pre>
33 * public interface UserMapper {
34 * @Lang(MyXMLLanguageDriver.class)
35 * @Select("SELECT id, name FROM users WHERE id = #{id}")
36 * User selectById(int id);
37 * }
38 * </pre>
39 *
40 * @author Clinton Begin
41 */
42 @Documented
43 @Retention(RetentionPolicy.RUNTIME)
44 @Target(ElementType.METHOD)
45 public @interface Lang {
46 /**
47 * Returns the {@link LanguageDriver} implementation type to use.
48 *
49 * @return the {@link LanguageDriver} implementation type
50 */
51 Class<? extends LanguageDriver> value();
52 }