AbstractTypeConvertingFunction (MyBatis Dynamic SQL 1.3.1 API)

java.lang.Object
- org.mybatis.dynamic.sql.select.function.AbstractTypeConvertingFunction<T,R,U>

Type Parameters:

T - The type of the underlying column. For example, if a function converts a VARCHAR to an INT, then the underlying type will be a String

R - The type of the column after the conversion. For example, if a function converts a VARCHAR to an INT, then the converted type will be Integer

U - the specific subtype that implements the function

All Implemented Interfaces:

BasicColumn, BindableColumn<R>

Direct Known Subclasses:

AbstractUniTypeFunction
```
public abstract class AbstractTypeConvertingFunction<T,R,U extends AbstractTypeConvertingFunction<T,R,U>>
extends Object
implements BindableColumn<R>
```
Represents a function that can change the underlying type. For example, converting a binary field for a base64 string, or an integer to a string, etc.
Thanks to @endink for the idea.

Author:

Jeff Butler

Field Summary

Fields
Modifier and Type Field Description

protected String alias

protected BindableColumn<T> column

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractTypeConvertingFunction(BindableColumn<T> column)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<String>`	`alias()`	Returns the columns alias if one has been specified.
`U`	`as(String alias)`	Override the base method definition to make it more specific to this interface.
`protected abstract U`	`copy()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mybatis.dynamic.sql.BasicColumn
renderWithTableAlias, renderWithTableAndColumnAlias

Methods inherited from interface org.mybatis.dynamic.sql.BindableColumn
convertParameterType, javaType, jdbcType, renderingStrategy, typeHandler

- Field Detail
  - column
```
protected final BindableColumn<T> column
```
  - alias
```
protected String alias
```
- Constructor Detail
  - AbstractTypeConvertingFunction
```
protected AbstractTypeConvertingFunction(BindableColumn<T> column)
```
- Method Detail
  - alias
```
public Optional<String> alias()
```
    Description copied from interface: BasicColumn
    
    Returns the columns alias if one has been specified.
    
    Specified by:
    
    alias in interface BasicColumn
    
    Returns:
    
    the column alias
  - as
```
public U as(String alias)
```
    Description copied from interface: BindableColumn
    
    Override the base method definition to make it more specific to this interface.
    
    Specified by:
    
    as in interface BasicColumn
    
    Specified by:
    
    as in interface BindableColumn<T>
    
    Parameters:
    
    alias - the column alias to set
    
    Returns:
    
    new instance with alias set
  - copy
```
protected abstract U copy()
```