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

Interface ToDocumentFieldValueConvertContextExtension<T>

Type Parameters:

T - The type of extended contexts.

All Superinterfaces:

ToDocumentValueConvertContextExtension<T>

@Deprecated
public interface ToDocumentFieldValueConvertContextExtension<T>
extends ToDocumentValueConvertContextExtension<T>

Deprecated.

Use ToDocumentValueConverter with ToDocumentValueConvertContext and ToDocumentValueConvertContextExtension instead.

An extension to ToDocumentFieldValueConvertContext, 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:

ToDocumentFieldValueConvertContext.extension(ToDocumentFieldValueConvertContextExtension)

Method Summary

Modifier and Type	Method	Description
Optional<T>	extendOptional(ToDocumentFieldValueConvertContext original, BackendMappingContext mappingContext)	Deprecated. Attempt to extend a given context, returning an empty Optional in case of failure.
default Optional<T>	extendOptional(ToDocumentValueConvertContext original, BackendMappingContext mappingContext)	Deprecated. Attempt to extend a given context, returning an empty Optional in case of failure.

Method Detail

extendOptional

default Optional<T> extendOptional(ToDocumentValueConvertContext original,
                                   BackendMappingContext mappingContext)

Deprecated.

Description copied from interface: ToDocumentValueConvertContextExtension

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 ToDocumentValueConvertContextExtension<T>

Parameters:

original - The original, non-extended ToDocumentValueConvertContext.

mappingContext - A BackendMappingContext.

Returns:

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

extendOptional

Optional<T> extendOptional(ToDocumentFieldValueConvertContext original,
                           BackendMappingContext mappingContext)

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 ToDocumentFieldValueConvertContext.

mappingContext - A BackendMappingContext.

Returns:

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