Skip to main content

Migrate UserType to Hibernate 6

org.openrewrite.hibernate.MigrateUserType

With Hibernate 6 the UserType interface received a type parameter making it more strictly typed. This recipe applies the changes required to adhere to this change.

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Example

Before
import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.usertype.UserType;

import java.io.Serializable;
import java.math.BigDecimal;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
import java.util.Objects;

public class BigDecimalAsString implements UserType {

@Override
public int[] sqlTypes() {
return new int[]{Types.VARCHAR};
}

@Override
public Class returnedClass() {
return BigDecimal.class;
}

@Override
public boolean equals(Object x, Object y) {
return Objects.equals(x, y);
}

@Override
public int hashCode(Object x) {
return Objects.hashCode(x);
}

@Override
public Object nullSafeGet(ResultSet rs, String[] names, SharedSessionContractImplementor session, Object owner) throws SQLException {
String string = rs.getString(names[0]);
return string == null || rs.wasNull() ? null : new BigDecimal(string);
}

@Override
public void nullSafeSet(PreparedStatement st, Object value, int index, SharedSessionContractImplementor session) throws SQLException {
if (value == null) {
st.setNull(index, Types.VARCHAR);
} else {
st.setString(index, value.toString());
}
}

@Override
public Object deepCopy(Object value1) {
return value1;
}

@Override
public boolean isMutable() {
return false;
}

@Override
public Serializable disassemble(Object value) {
return (BigDecimal) value;
}

@Override
public Object assemble(Serializable cached, Object owner) {
return cached;
}

@Override
public Object replace(Object original, Object target, Object owner) {
return original;
}
}
After
import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.usertype.UserType;

import java.io.Serializable;
import java.math.BigDecimal;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
import java.util.Objects;

public class BigDecimalAsString implements UserType<BigDecimal> {

@Override
public int getSqlType() {
return Types.VARCHAR;
}

@Override
public Class<BigDecimal> returnedClass() {
return BigDecimal.class;
}

@Override
public boolean equals(BigDecimal x, BigDecimal y) {
return Objects.equals(x, y);
}

@Override
public int hashCode(BigDecimal x) {
return Objects.hashCode(x);
}

@Override
public BigDecimal nullSafeGet(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner) throws SQLException {
String string = rs.getString(position);
return string == null || rs.wasNull() ? null : new BigDecimal(string);
}

@Override
public void nullSafeSet(PreparedStatement st, BigDecimal value, int index, SharedSessionContractImplementor session) throws SQLException {
if (value == null) {
st.setNull(index, Types.VARCHAR);
} else {
st.setString(index, value.toString());
}
}

@Override
public BigDecimal deepCopy(BigDecimal value1) {
return value1;
}

@Override
public boolean isMutable() {
return false;
}

@Override
public Serializable disassemble(BigDecimal value) {
return value;
}

@Override
public BigDecimal assemble(Serializable cached, Object owner) {
return (BigDecimal) cached;
}

@Override
public BigDecimal replace(BigDecimal original, BigDecimal target, Object owner) {
return original;
}
}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-hibernate in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("7.6.1")
}

rewrite {
activeRecipe("org.openrewrite.hibernate.MigrateUserType")
setExportDatatables(true)
}

repositories {
mavenCentral()
}

dependencies {
rewrite("org.openrewrite.recipe:rewrite-hibernate:2.7.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors

Laurens Westerlaken, Tim te Beek, Jonathan Schnéider