com.speedment.runtime.core.component.sql.SqlTypeMapperHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation
Show all versions of tool-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
The newest version!
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.runtime.core.component.sql;
import com.speedment.runtime.config.Project;
import com.speedment.runtime.core.internal.component.sql.SqlTypeMapperHelperImpl;
import com.speedment.runtime.field.Field;
import com.speedment.runtime.typemapper.TypeMapper;
/**
* A helper class that makes it easier to create and invoke instances of
* {@link TypeMapper} when a relational SQL database source is used. The method
* is indended to be used by the generated entity managers.
*
* @param the JDBC type of the field
* @param the java type of the field
*
* @author Emil Forslund
* @since 3.0.1
*/
public interface SqlTypeMapperHelper {
/**
* Converts the specified value in JDBC form to the appropriate java type by
* using the {@link TypeMapper} contained in this helper.
*
* @param dbValue the database (JDBC) value
* @return the converted value ready to be put into an entity
*/
JAVA_TYPE apply(DB_TYPE dbValue);
/**
* Creates a new {@link SqlTypeMapperHelper} by using the default
* implementation.
*
* @param the entity type
* @param the value database (JDBC) type
* @param the expected value java type
* @param project the current project instance
* @param field the field that this helper is mapping
* @param entityClass the class of the entity interface
* @return the new {@link SqlTypeMapperHelper}
*/
static
SqlTypeMapperHelper create(
Project project,
Field field,
Class entityClass) {
return new SqlTypeMapperHelperImpl<>(project, field, entityClass);
}
}