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

Interface FromDocumentFieldValueConvertContextExtension<T>

Type Parameters:

T - The type of extended contexts.

All Superinterfaces:

FromDocumentValueConvertContextExtension<T>

All Known Implementing Classes:

HibernateOrmExtension

@Deprecated
public interface FromDocumentFieldValueConvertContextExtension<T>
extends FromDocumentValueConvertContextExtension<T>

Deprecated.

Use FromDocumentValueConverter with FromDocumentValueConvertContext and FromDocumentValueConvertContextExtension instead.

An extension to FromDocumentFieldValueConvertContext, allowing to access non-standard context specific to a given mapper.

WARNING: while this type is API, because instances should be manipulated by users, all of its methods are considered SPIs and therefore should never be called or implemented directly by users. In short, users are only expected to get instances of this type from an API (SomeExtension.get()) and pass it to another API.

See Also:

FromDocumentFieldValueConvertContext.extension(FromDocumentFieldValueConvertContextExtension)

Method Summary

Modifier and Type	Method	Description
Optional<T>	extendOptional(FromDocumentFieldValueConvertContext original, BackendSessionContext sessionContext)	Deprecated. Attempt to extend a given context, returning an empty Optional in case of failure.
default Optional<T>	extendOptional(FromDocumentValueConvertContext original, BackendSessionContext sessionContext)	Deprecated. Attempt to extend a given context, returning an empty Optional in case of failure.

Method Detail

extendOptional

default Optional<T> extendOptional(FromDocumentValueConvertContext original,
                                   BackendSessionContext sessionContext)

Deprecated.

Description copied from interface: FromDocumentValueConvertContextExtension

Attempt to extend a given context, returning an empty Optional in case of failure.

WARNING: this method is not API, see comments at the type level.

Specified by:

extendOptional in interface FromDocumentValueConvertContextExtension<T>

Parameters:

original - The original, non-extended FromDocumentValueConvertContext.

sessionContext - A BackendSessionContext.

Returns:

An optional containing the extended context (FromDocumentValueConvertContextExtension) in case of success, or an empty optional otherwise.

extendOptional

Optional<T> extendOptional(FromDocumentFieldValueConvertContext original,
                           BackendSessionContext sessionContext)

Deprecated.

Attempt to extend a given context, returning an empty Optional in case of failure.

WARNING: this method is not API, see comments at the type level.

Parameters:

original - The original, non-extended FromDocumentFieldValueConvertContext.

sessionContext - A BackendSessionContext.

Returns:

An optional containing the extended context (FromDocumentFieldValueConvertContextExtension) in case of success, or an empty optional otherwise.