Package org.hibernate.search.engine.backend.types.converter.spi

Class PassThroughToDocumentFieldValueConverter<F>

java.lang.Object

org.hibernate.search.engine.backend.types.converter.spi.PassThroughToDocumentFieldValueConverter<F>

All Implemented Interfaces:

ToDocumentFieldValueConverter<F,F>

public final class PassThroughToDocumentFieldValueConverter<F>
extends Object
implements ToDocumentFieldValueConverter<F,F>

Constructor Summary

Constructors

Constructor	Description
PassThroughToDocumentFieldValueConverter()

Method Summary

Modifier and Type	Method	Description
F	convert(F value, ToDocumentFieldValueConvertContext context)
boolean	isCompatibleWith(ToDocumentFieldValueConverter<?,?> other)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PassThroughToDocumentFieldValueConverter

public PassThroughToDocumentFieldValueConverter()

Method Detail

convert

public F convert(F value,
                 ToDocumentFieldValueConvertContext context)

Specified by:

convert in interface ToDocumentFieldValueConverter<F,F>

Parameters:

value - The source value to convert.

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM SessionFactory (if using the Hibernate ORM mapper).

Returns:

The converted index field value.

isCompatibleWith

public boolean isCompatibleWith(ToDocumentFieldValueConverter<?,?> other)

Specified by:

isCompatibleWith in interface ToDocumentFieldValueConverter<F,F>

Parameters:

other - Another ToDocumentFieldValueConverter, never null.

Returns:

true if the given object behaves exactly the same as this object, i.e. its ToDocumentFieldValueConverter.convert(Object, ToDocumentFieldValueConvertContext) method is guaranteed to always return the same value as this object's when given the same input. false otherwise, or when in doubt.