public interface

JavaTypeResolver

org.mybatis.generator.api.JavaTypeResolver
Known Indirect Subclasses

Class Overview

This interface describes methods that are required in any Java type resolver. A Java type resolver is used to make a default translation between a JDBC type as returned from the database introspection process, and a Java type.

Summary

Public Methods
abstract void addConfigurationProperties(Properties properties)
Adds properties for this instance from any properties configured in the JavaTypeResolverConfiguration.
abstract FullyQualifiedJavaType calculateJavaType(IntrospectedColumn introspectedColumn)
Calculates and returns the Java type that should be associated with this column based on the jdbc type, length, and scale of the column.
abstract String calculateJdbcTypeName(IntrospectedColumn introspectedColumn)
Calculates and returns the JDBC type name that should be associated with this column based on the jdbc type, length, and scale of the column.
abstract void setContext(Context context)
Sets the instance of the Context object associated with this instance.
abstract void setWarnings(List<String> warnings)
The generator will supply a list to this method.

Public Methods

public abstract void addConfigurationProperties (Properties properties)

Adds properties for this instance from any properties configured in the JavaTypeResolverConfiguration. This method will be called before any of the get methods.

Parameters
properties All properties from the configuration

public abstract FullyQualifiedJavaType calculateJavaType (IntrospectedColumn introspectedColumn)

Calculates and returns the Java type that should be associated with this column based on the jdbc type, length, and scale of the column.

Parameters
introspectedColumn the column whose Java type needs to be calculated
Returns
  • the calculated type, or null if an unsupported data type. If null is returned, we will set the type to Object and issue a warning unless the column is ignored or otherwise overridden

public abstract String calculateJdbcTypeName (IntrospectedColumn introspectedColumn)

Calculates and returns the JDBC type name that should be associated with this column based on the jdbc type, length, and scale of the column.

Parameters
introspectedColumn the column whose Java type needs to be calculated
Returns
  • the calculated type name, or null if an unsupported data type. If null is returned, we will set the type to OTHER and issue a warning unless the column is ignored or otherwise overridden

public abstract void setContext (Context context)

Sets the instance of the Context object associated with this instance. This method will be called before any of the get methods.

Parameters
context The current Context

public abstract void setWarnings (List<String> warnings)

The generator will supply a list to this method. The implementation class may add strings to the list that will be treated as warning messages and displayed to the user. The concept of a warning is that code generation can continue, but that the results may not be what is expected.