HHH-19340 make TypedParameterValue a record

Author: gavinking

hibernate-core/src/main/java/org/hibernate/query/TypedParameterValue.java

@@ -7,6 +7,8 @@
 
 import org.hibernate.type.BasicTypeReference;
 
+import java.util.Objects;
+
 /**
  * Represents a typed argument to a query parameter.
  * <p>
@@ -21,7 +23,7 @@
  * For example:
  * <pre>
  * query.setParameter("stringNamedParam",
- *         new TypedParameterValue(StandardBasicTypes.STRING, null))
+ *         TypedParameterValue.ofNull(StandardBasicTypes.STRING))
  * </pre>
  * <p>
  * Here, a "null string" argument was bound to the named parameter
@@ -38,26 +40,38 @@
  *
  * @see org.hibernate.type.StandardBasicTypes
  */
-public final class TypedParameterValue<J> {
+public record TypedParameterValue<J>(BindableType<J> type, J value) {
 
-	private final BindableType<J> type;
-	private final J value;
+	public TypedParameterValue {
+		Objects.requireNonNull( type, "type must not be null" );
+	}
 
-	public TypedParameterValue(BindableType<J> type, J value) {
-		this.type = type;
-		this.value = value;
+	/**
+	 * Obtain an instance with the given type and given value.
+	 *
+	 * @since 7.0
+	 */
+	public static <J> TypedParameterValue<J> of(BindableType<J> type, J value) {
+		return new TypedParameterValue<>( type, value );
 	}
 
-	public TypedParameterValue(BasicTypeReference<J> type, J value) {
-		this.type = type;
-		this.value = value;
+	/**
+	 * Obtain an instance with the given type and a null value.
+	 *
+	 * @since 7.0
+	 */
+	public static <J> TypedParameterValue<J> ofNull(BindableType<J> type) {
+		return new TypedParameterValue<>( type, null );
 	}
 
 	/**
 	 * The value to bind
 	 *
 	 * @return The value to be bound
+	 *
+	 * @deprecated use {@link #value}
 	 */
+	@Deprecated(since = "7")
 	public J getValue() {
 		return value;
 	}
@@ -66,7 +80,10 @@ public J getValue() {
 	 * The specific Hibernate type to use to bind the value.
 	 *
 	 * @return The Hibernate type to use.
+	 *
+	 * @deprecated use {@link #type}
 	 */
+	@Deprecated(since = "7")
 	public BindableType<J> getType() {
 		return type;
 	}
@@ -75,8 +92,11 @@ public BindableType<J> getType() {
 	 * The specific Hibernate type reference to use to bind the value.
 	 *
 	 * @return The Hibernate type reference to use.
+	 *
+	 * @deprecated use {@link #type}
 	 */
+	@Deprecated(since = "7")
 	public BasicTypeReference<J> getTypeReference() {
-		return type instanceof BasicTypeReference ? (BasicTypeReference<J>) type : null;
+		return type instanceof BasicTypeReference<J> reference ? reference : null;
 	}
 }

hibernate-core/src/main/java/org/hibernate/query/spi/AbstractCommonQueryContract.java

@@ -773,13 +773,11 @@ private boolean multipleBinding(QueryParameter<Object> param, Object value){
 	}
 
 	private <T> void setTypedParameter(String name, TypedParameterValue<T> typedValue) {
-		final BindableType<T> type = typedValue.getType();
-		setParameter( name, typedValue.getValue(), type != null ? type : typedValue.getTypeReference() );
+		setParameter( name, typedValue.value(), typedValue.type() );
 	}
 
 	private <T> void setTypedParameter(int position, TypedParameterValue<T> typedValue) {
-		final BindableType<T> type = typedValue.getType();
-		setParameter( position, typedValue.getValue(), type != null ? type : typedValue.getTypeReference() );
+		setParameter( position, typedValue.value(), typedValue.type() );
 	}
 
 	private boolean isInstance(BindableType<?> parameterType, Object value) {
@@ -889,19 +887,17 @@ public <P> CommonQueryContract setParameter(QueryParameter<P> parameter, P value
 	public <P> CommonQueryContract setParameter(Parameter<P> parameter, P value) {
 		if ( value instanceof TypedParameterValue<?> typedParameterValue ) {
 			final Class<P> parameterType = parameter.getParameterType();
-			final BindableType<?> type = typedParameterValue.getType();
-			final BindableType<?> bindableType = type == null ? typedParameterValue.getTypeReference() : type;
-			if ( bindableType == null ) {
+			final BindableType<?> type = typedParameterValue.type();
+			if ( type == null ) {
 				throw new IllegalArgumentException( "TypedParameterValue has no type" );
 			}
-			if ( !parameterType.isAssignableFrom( bindableType.getBindableJavaType() ) ) {
+			if ( !parameterType.isAssignableFrom( type.getBindableJavaType() ) ) {
 				throw new QueryArgumentException( "Given TypedParameterValue is not assignable to given Parameter type",
-						parameterType, typedParameterValue.getValue() );
+						parameterType, typedParameterValue.value() );
 			}
 			@SuppressWarnings("unchecked") // safe, because we just checked
 			final TypedParameterValue<P> typedValue = (TypedParameterValue<P>) value;
-			setParameter( parameter, typedValue.getValue(),
-					type == null ? typedValue.getTypeReference() : typedValue.getType() );
+			setParameter( parameter, typedValue.value(), typedValue.type() );
 		}
 		else {
 			locateBinding( parameter ).setBindValue( value, resolveJdbcParameterTypeIfNecessary() );

hibernate-core/src/test/java/org/hibernate/orm/test/jpa/query/TypedValueParametersTest.java

@@ -87,7 +87,7 @@ public void testJpa(EntityManagerFactoryScope scope) {
 						TagUserType.INSTANCE,
 						scope.getEntityManagerFactory().unwrap( SessionFactoryImplementor.class ).getTypeConfiguration()
 				);
-				q.setParameter("tags", new TypedParameterValue<>( customType, Arrays.asList("important","business")));
+				q.setParameter("tags", TypedParameterValue.of(customType, Arrays.asList("important","business")));
 			}
 		);
 	}

hibernate-core/src/test/java/org/hibernate/orm/test/procedure/StoredProcedureParameterTypeTest.java

@@ -432,11 +432,11 @@ public void testTypedParameterValueInParameter(SessionFactoryScope scope) {
 				session -> {
 					ProcedureCall procedureCall = session.createStoredProcedureCall( "test" );
 					procedureCall.registerParameter( 1, StandardBasicTypes.STRING, ParameterMode.IN );
-					procedureCall.setParameter( 1, new TypedParameterValue( StandardBasicTypes.STRING, "test" ) );
+					procedureCall.setParameter( 1, TypedParameterValue.of( StandardBasicTypes.STRING, "test" ) );
 
 					procedureCall = session.createStoredProcedureCall( "test" );
 					procedureCall.registerParameter( "test", StandardBasicTypes.STRING, ParameterMode.IN );
-					procedureCall.setParameter( "test", new TypedParameterValue( StandardBasicTypes.STRING, "test" ) );
+					procedureCall.setParameter( "test", TypedParameterValue.of( StandardBasicTypes.STRING, "test" ) );
 				}
 		);
 	}
@@ -449,7 +449,7 @@ public void testTypedParameterValueInParameterWithNotSpecifiedType(SessionFactor
 					try {
 						ProcedureCall procedureCall = session.createStoredProcedureCall( "test" );
 						procedureCall.registerParameter( 1, StandardBasicTypes.STRING, ParameterMode.IN );
-						procedureCall.setParameter( 1, new TypedParameterValue( StandardBasicTypes.INTEGER, 1 ) );
+						procedureCall.setParameter( 1, TypedParameterValue.of( StandardBasicTypes.INTEGER, 1 ) );
 					}
 					catch (IllegalArgumentException e) {
 						assertTrue( e.getMessage().contains( "was not of specified type" ) );