Interface FromDocumentFieldValueConverter<F,V>
-
- Type Parameters:
F
- The type of source, index field values.V
- The type of target values.
- All Known Implementing Classes:
PassThroughFromDocumentFieldValueConverter
public interface FromDocumentFieldValueConverter<F,V>
A converter from a source index field value to a different value.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description V
convert(F value, FromDocumentFieldValueConvertContext context)
default boolean
isCompatibleWith(FromDocumentFieldValueConverter<?,?> other)
-
-
-
Method Detail
-
convert
V convert(F value, FromDocumentFieldValueConvertContext context)
- Parameters:
value
- The index field value to convert.context
- A context that can beextended
to a more useful type, giving access to such things as a Hibernate ORM Session (if using the Hibernate ORM mapper).- Returns:
- The converted value.
-
isCompatibleWith
default boolean isCompatibleWith(FromDocumentFieldValueConverter<?,?> other)
- Parameters:
other
- AnotherToDocumentFieldValueConverter
, nevernull
.- Returns:
true
if the given object behaves exactly the same as this object, i.e. itsconvert(Object, FromDocumentFieldValueConvertContext)
method is guaranteed to always return the same value as this object's when given the same input.false
otherwise, or when in doubt.
-
-