HSEARCH-3608 Introduce optional param get

To use in case we can expect that the param has not been defined for the current binding
hibernate · Apr 29, 2021 · 02b6077 · 02b6077
1 parent 6942501
commit 02b6077
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 38 deletions.
diff --git a/...a/org/hibernate/search/integrationtest/mapper/pojo/mapping/definition/GenericFieldIT.java b/...a/org/hibernate/search/integrationtest/mapper/pojo/mapping/definition/GenericFieldIT.java
@@ -12,6 +12,7 @@
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.engine.backend.types.Aggregable;
 import org.hibernate.search.engine.backend.types.Searchable;
@@ -374,16 +375,16 @@ public T toIndexedValue(String value, ValueBridgeToIndexedValueContext context)
 
 	public static class ParametricBridge implements ValueBridge<Integer, String> {
 
-		private final Integer base;
+		private final int base;
 
-		private ParametricBridge(Integer base) {
+		private ParametricBridge(int base) {
 			this.base = base;
 		}
 
 		@Override
 		public String toIndexedValue(Integer value, ValueBridgeToIndexedValueContext context) {
 			if ( value == null ) {
-				return base.toString();
+				return base + "";
 			}
 
 			return ( value % base ) + "";
@@ -398,17 +399,13 @@ public void bind(ValueBindingContext<?> context) {
 		}
 
 		@SuppressWarnings("uncheked")
-		private static Integer extractBase(ValueBindingContext<?> context) {
-			Integer base = (Integer) context.param( "base" );
-			if ( base != null ) {
-				return base;
+		private static int extractBase(ValueBindingContext<?> context) {
+			Optional<Object> optionalBase = context.paramOptional( "base" );
+			if ( optionalBase.isPresent() ) {
+				return (Integer) optionalBase.get();
 			}
 
 			String stringBase = (String) context.param( "stringBase" );
-			if ( stringBase == null ) {
-				return 0;
-			}
-
 			return Integer.parseInt( stringBase );
 		}
 	}

diff --git a/...ibernate/search/integrationtest/mapper/pojo/mapping/definition/IndexedEmbeddedBaseIT.java b/...ibernate/search/integrationtest/mapper/pojo/mapping/definition/IndexedEmbeddedBaseIT.java
@@ -15,6 +15,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Consumer;
 import java.util.function.Function;
 
@@ -1414,10 +1415,10 @@ public void bind(IdentifierBindingContext<?> context) {
 		}
 
 		@SuppressWarnings("uncheked")
-		private static Integer extractBase(IdentifierBindingContext<?> context) {
-			Integer base = (Integer) context.param( "base" );
-			if ( base != null ) {
-				return base;
+		private static int extractBase(IdentifierBindingContext<?> context) {
+			Optional<Object> optionalBase = context.paramOptional( "base" );
+			if ( optionalBase.isPresent() ) {
+				return (Integer) optionalBase.get();
 			}
 
 			String stringBase = (String) context.param( "stringBase" );

diff --git a/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/MarkerBindingBaseIT.java b/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/MarkerBindingBaseIT.java
@@ -10,6 +10,7 @@
 
 import java.lang.invoke.MethodHandles;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
 import org.hibernate.search.mapper.pojo.bridge.binding.BindingContext;
@@ -85,10 +86,10 @@ public void bind(MarkerBindingContext context) {
 		}
 
 		@SuppressWarnings("uncheked")
-		private static Integer extractScale(BindingContext context) {
-			Integer scale = (Integer) context.param( "scale" );
-			if ( scale != null ) {
-				return scale;
+		private static int extractScale(BindingContext context) {
+			Optional<Object> optionalScale = context.paramOptional( "scale" );
+			if ( optionalScale.isPresent() ) {
+				return (Integer) optionalScale.get();
 			}
 
 			String stringScale = (String) context.param( "stringScale" );

diff --git a/...ibernate/search/integrationtest/mapper/pojo/mapping/definition/PropertyBindingBaseIT.java b/...ibernate/search/integrationtest/mapper/pojo/mapping/definition/PropertyBindingBaseIT.java
@@ -10,6 +10,7 @@
 
 import java.lang.invoke.MethodHandles;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.engine.backend.document.DocumentElement;
 import org.hibernate.search.engine.backend.document.IndexFieldReference;
@@ -184,7 +185,7 @@ public void bind(PropertyBindingContext context) {
 					.toReference();
 			IndexFieldReference<Integer> diff = context.indexSchemaElement().field( "diff", f -> f.asInteger() )
 					.toReference();
-			Integer base = extractBase( context );
+			int base = extractBase( context );
 
 			context.bridge( Integer.class, (DocumentElement target, Integer bridgedElement,
 					PropertyBridgeWriteContext writeContext) -> {
@@ -194,10 +195,10 @@ public void bind(PropertyBindingContext context) {
 		}
 
 		@SuppressWarnings("uncheked")
-		private static Integer extractBase(PropertyBindingContext context) {
-			Integer base = (Integer) context.param( "base" );
-			if ( base != null ) {
-				return base;
+		private static int extractBase(PropertyBindingContext context) {
+			Optional<Object> optionalBase = context.paramOptional( "base" );
+			if ( optionalBase.isPresent() ) {
+				return (Integer) optionalBase.get();
 			}
 
 			String stringBase = (String) context.param( "stringBase" );

diff --git a/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/RoutingBridgeBaseIT.java b/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/RoutingBridgeBaseIT.java
@@ -10,6 +10,7 @@
 
 import java.lang.invoke.MethodHandles;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.integrationtest.mapper.pojo.testsupport.util.rule.JavaBeanMappingSetupHelper;
 import org.hibernate.search.integrationtest.mapper.pojo.work.operations.PojoIndexingPlanOperationIT;
@@ -731,9 +732,9 @@ public void bind(RoutingBindingContext context) {
 
 		@SuppressWarnings("uncheked")
 		private static int modulus(RoutingBindingContext context) {
-			Integer modulus = (Integer) context.param( "modulus" );
-			if ( modulus != null ) {
-				return modulus;
+			Optional<Object> optionalModulus = context.paramOptional( "modulus" );
+			if ( optionalModulus.isPresent() ) {
+				return (Integer) optionalModulus.get();
 			}
 
 			String stringModulus = (String) context.param( "stringModulus" );

diff --git a/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/ScaledNumberFieldIT.java b/.../hibernate/search/integrationtest/mapper/pojo/mapping/definition/ScaledNumberFieldIT.java
@@ -12,6 +12,7 @@
 import java.math.BigDecimal;
 import java.math.BigInteger;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.engine.backend.types.Aggregable;
 import org.hibernate.search.engine.backend.types.Searchable;
@@ -517,18 +518,13 @@ public void bind(ValueBindingContext<?> context) {
 
 		@SuppressWarnings("uncheked")
 		private static BigDecimal extractBaseDecimal(ValueBindingContext<?> context) {
-			BigDecimal baseDecimal = (BigDecimal) context.param( "baseDecimal" );
-			if ( baseDecimal != null ) {
-				return baseDecimal;
+			Optional<Object> optionalBaseDecimal = context.paramOptional( "baseDecimal" );
+			if ( optionalBaseDecimal.isPresent() ) {
+				return (BigDecimal) optionalBaseDecimal.get();
 			}
 
 			Object unscaledValParam = context.param( "unscaledVal" );
 			Object scaleParam = context.param( "scale" );
-
-			if ( unscaledValParam == null || scaleParam == null ) {
-				return BigDecimal.ZERO;
-			}
-
 			BigInteger unscaledVal = new BigInteger( (String) unscaledValParam );
 			int scale = Integer.parseInt( (String) scaleParam );
 			return new BigDecimal( unscaledVal, scale );

diff --git a/...rg/hibernate/search/integrationtest/mapper/pojo/mapping/definition/TypeBindingBaseIT.java b/...rg/hibernate/search/integrationtest/mapper/pojo/mapping/definition/TypeBindingBaseIT.java
@@ -10,6 +10,7 @@
 
 import java.lang.invoke.MethodHandles;
 import java.util.Collections;
+import java.util.Optional;
 
 import org.hibernate.search.engine.backend.document.DocumentElement;
 import org.hibernate.search.engine.backend.document.IndexFieldReference;
@@ -206,9 +207,9 @@ else if ( bridgedElement instanceof NotAnnotatedEntity ) {
 
 	@SuppressWarnings("uncheked")
 	private static Integer extractBase(TypeBindingContext context) {
-		Integer base = (Integer) context.param( "base" );
-		if ( base != null ) {
-			return base;
+		Optional<Object> optionalBase = context.paramOptional( "base" );
+		if ( optionalBase.isPresent() ) {
+			return (Integer) optionalBase.get();
 		}
 
 		String stringBase = (String) context.param( "stringBase" );

diff --git a/...jo-base/src/main/java/org/hibernate/search/mapper/pojo/bridge/binding/BindingContext.java b/...jo-base/src/main/java/org/hibernate/search/mapper/pojo/bridge/binding/BindingContext.java
@@ -6,6 +6,8 @@
  */
 package org.hibernate.search.mapper.pojo.bridge.binding;
 
+import java.util.Optional;
+
 import org.hibernate.search.engine.environment.bean.BeanResolver;
 import org.hibernate.search.util.common.SearchException;
 
@@ -24,4 +26,11 @@ public interface BindingContext {
 	 */
 	Object param(String name);
 
+	/**
+	 * @param name The name of the param
+	 * @return Get an optional param defined for the binder by the given name,
+	 * a param having such name may either exist or not.
+	 */
+	Optional<Object> paramOptional(String name);
+
 }
diff --git a/...ain/java/org/hibernate/search/mapper/pojo/bridge/binding/impl/AbstractBindingContext.java b/...ain/java/org/hibernate/search/mapper/pojo/bridge/binding/impl/AbstractBindingContext.java
@@ -8,6 +8,7 @@
 
 import java.lang.invoke.MethodHandles;
 import java.util.Map;
+import java.util.Optional;
 
 import org.hibernate.search.engine.environment.bean.BeanResolver;
 import org.hibernate.search.mapper.pojo.bridge.binding.BindingContext;
@@ -40,4 +41,9 @@ public Object param(String name) {
 
 		return value;
 	}
+
+	@Override
+	public Optional<Object> paramOptional(String name) {
+		return Optional.ofNullable( params.get( name ) );
+	}
 }
diff --git a/...rammatic/identifiertovalue/impl/ValueBindingContextToIdentifierBindingContextAdapter.java b/...rammatic/identifiertovalue/impl/ValueBindingContextToIdentifierBindingContextAdapter.java
@@ -6,6 +6,8 @@
  */
 package org.hibernate.search.mapper.pojo.bridge.mapping.programmatic.identifiertovalue.impl;
 
+import java.util.Optional;
+
 import org.hibernate.search.engine.environment.bean.BeanHolder;
 import org.hibernate.search.engine.environment.bean.BeanResolver;
 import org.hibernate.search.mapper.pojo.bridge.IdentifierBridge;
@@ -44,6 +46,11 @@ public Object param(String name) {
 		return delegate.param( name );
 	}
 
+	@Override
+	public Optional<Object> paramOptional(String name) {
+		return delegate.paramOptional( name );
+	}
+
 	@Override
 	public BeanResolver beanResolver() {
 		return delegate.beanResolver();