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