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.type;
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   * The annotation that specify jdbc types to map {@link TypeHandler}.
26   * <p>
27   * <b>How to use:</b>
28   *
29   * <pre>
30   * &#064;MappedJdbcTypes({ JdbcType.CHAR, JdbcType.VARCHAR })
31   * public class StringTrimmingTypeHandler implements TypeHandler&lt;String&gt; {
32   *   // ...
33   * }
34   * </pre>
35   *
36   * @author Eduardo Macarron
37   */
38  @Documented
39  @Retention(RetentionPolicy.RUNTIME)
40  @Target(ElementType.TYPE)
41  public @interface MappedJdbcTypes {
42    /**
43     * Returns jdbc types to map {@link TypeHandler}.
44     *
45     * @return jdbc types
46     */
47    JdbcType[] value();
48  
49    /**
50     * Returns whether map to jdbc null type.
51     *
52     * @return {@code true} if map, {@code false} if otherwise
53     */
54    boolean includeNullJdbcType() default false;
55  }