HSEARCH-3649 Add a method to query the accepted input types of a ToDo…

…cumentFieldValueConverter
hibernate · Sep 3, 2019 · 7c611cb · 7c611cb
1 parent d1ca6a6
commit 7c611cb
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 7 deletions.
diff --git a/...va/org/hibernate/search/engine/backend/types/converter/ToDocumentFieldValueConverter.java b/...va/org/hibernate/search/engine/backend/types/converter/ToDocumentFieldValueConverter.java
@@ -17,6 +17,20 @@
  */
 public interface ToDocumentFieldValueConverter<V, F> {
 
+	/**
+	 * Check whether the given type is a valid type for values passed
+	 * to {@link #convert(Object, ToDocumentFieldValueConvertContext)},
+	 * which generally means the given type is a subtype of {@link V}.
+	 * <p>
+	 * This method is generally implemented like this:
+	 * {@code return TheInputType.class.isAssignableFrom( inputTypeCandidate )}.
+	 * @param inputTypeCandidate A candidate type for the input of {@link #convertUnknown(Object, ToDocumentFieldValueConvertContext)}.
+	 * @return {@code true} if values of type {@code inputTypeCandidate}
+	 * may be accepted by {@link #convertUnknown(Object, ToDocumentFieldValueConvertContext)},
+	 * {@code false} otherwise.
+	 */
+	boolean isValidInputType(Class<?> inputTypeCandidate);
+
 	/**
 	 * @param value The source value to convert.
 	 * @param context A context that can be

diff --git a/...e/search/engine/backend/types/converter/spi/PassThroughToDocumentFieldValueConverter.java b/...e/search/engine/backend/types/converter/spi/PassThroughToDocumentFieldValueConverter.java
@@ -23,6 +23,11 @@ public String toString() {
 		return getClass().getSimpleName() + "[" + valueType + "]";
 	}
 
+	@Override
+	public boolean isValidInputType(Class<?> inputTypeCandidate) {
+		return valueType.isAssignableFrom( inputTypeCandidate );
+	}
+
 	@Override
 	public F convert(F value, ToDocumentFieldValueConvertContext context) {
 		return value;

diff --git a/.../java/org/hibernate/search/integrationtest/backend/tck/testsupport/util/ValueWrapper.java b/.../java/org/hibernate/search/integrationtest/backend/tck/testsupport/util/ValueWrapper.java
@@ -22,6 +22,10 @@
 public final class ValueWrapper<T> {
 	public static <T> ToDocumentFieldValueConverter<ValueWrapper<T>, T> toIndexFieldConverter() {
 		return new ToDocumentFieldValueConverter<ValueWrapper<T>, T>() {
+			@Override
+			public boolean isValidInputType(Class<?> inputTypeCandidate) {
+				return ValueWrapper.class.isAssignableFrom( inputTypeCandidate );
+			}
 
 			@Override
 			public T convert(ValueWrapper<T> value, ToDocumentFieldValueConvertContext context) {

diff --git a/...hibernate/search/integrationtest/mapper/pojo/mapping/definition/FieldDefaultBridgeIT.java b/...hibernate/search/integrationtest/mapper/pojo/mapping/definition/FieldDefaultBridgeIT.java
@@ -282,6 +282,11 @@ private static final class IncompatibleType {
 
 	private static class IncompatibleToDocumentFieldValueConverter
 			implements ToDocumentFieldValueConverter<Object, Object> {
+		@Override
+		public boolean isValidInputType(Class<?> inputTypeCandidate) {
+			return Object.class.isAssignableFrom( inputTypeCandidate );
+		}
+
 		@Override
 		public Object convert(Object value, ToDocumentFieldValueConvertContext context) {
 			throw new UnsupportedOperationException();

diff --git a/.../search/mapper/pojo/bridge/binding/impl/PojoValueBridgeToDocumentFieldValueConverter.java b/.../search/mapper/pojo/bridge/binding/impl/PojoValueBridgeToDocumentFieldValueConverter.java
@@ -11,13 +11,13 @@
 import org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContext;
 import org.hibernate.search.mapper.pojo.bridge.ValueBridge;
 
-final class PojoValueBridgeToDocumentFieldValueConverter<U, V extends U, F> implements
-		ToDocumentFieldValueConverter<V, F> {
+final class PojoValueBridgeToDocumentFieldValueConverter<V, F>
+		implements ToDocumentFieldValueConverter<V, F> {
 
-	private final ValueBridge<U, F> bridge;
-	private final Class<U> expectedValueType;
+	private final ValueBridge<V, F> bridge;
+	private final Class<V> expectedValueType;
 
-	PojoValueBridgeToDocumentFieldValueConverter(ValueBridge<U, F> bridge, Class<U> expectedValueType) {
+	PojoValueBridgeToDocumentFieldValueConverter(ValueBridge<V, F> bridge, Class<V> expectedValueType) {
 		this.bridge = bridge;
 		this.expectedValueType = expectedValueType;
 	}
@@ -27,6 +27,11 @@ public String toString() {
 		return getClass().getSimpleName() + "[bridge=" + bridge + ", expectedValueType=" + expectedValueType + "]";
 	}
 
+	@Override
+	public boolean isValidInputType(Class<?> inputTypeCandidate) {
+		return expectedValueType.isAssignableFrom( inputTypeCandidate );
+	}
+
 	@Override
 	public F convert(V value, ToDocumentFieldValueConvertContext context) {
 		return bridge.toIndexedValue( value, context.extension( PojoValueBridgeContextExtension.INSTANCE ) );
@@ -42,8 +47,8 @@ public boolean isCompatibleWith(ToDocumentFieldValueConverter<?, ?> other) {
 		if ( other == null || !getClass().equals( other.getClass() ) ) {
 			return false;
 		}
-		PojoValueBridgeToDocumentFieldValueConverter<?, ?, ?> castedOther =
-				(PojoValueBridgeToDocumentFieldValueConverter<?, ?, ?>) other;
+		PojoValueBridgeToDocumentFieldValueConverter<?, ?> castedOther =
+				(PojoValueBridgeToDocumentFieldValueConverter<?, ?>) other;
 		return expectedValueType.equals( castedOther.expectedValueType )
 				&& bridge.isCompatibleWith( castedOther.bridge );
 	}