View Javadoc
1   /*
2    *    Copyright 2016-2025 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.mybatis.dynamic.sql;
17  
18  import java.util.Optional;
19  
20  import org.jspecify.annotations.Nullable;
21  
22  /**
23   * Describes a column with a known data type. The type is only used by the compiler to assure type safety
24   * when building clauses with conditions.
25   *
26   * @author Jeff Butler
27   *
28   * @param <T>
29   *            - the Java type that corresponds to this column
30   */
31  public interface BindableColumn<T> extends BasicColumn {
32  
33      /**
34       * Override the base method definition to make it more specific to this interface.
35       */
36      @Override
37      BindableColumn<T> as(String alias);
38  
39      default @Nullable Object convertParameterType(T value) {
40          return value;
41      }
42  
43      default Optional<Class<T>> javaType() {
44          return Optional.empty();
45      }
46  }