Package org.hibernate.search.mapper.orm

Class HibernateOrmExtension

java.lang.Object

org.hibernate.search.mapper.orm.HibernateOrmExtension

All Implemented Interfaces:

FromDocumentFieldValueConvertContextExtension<HibernateOrmSessionContext>, FromDocumentValueConvertContextExtension<HibernateOrmSessionContext>, ToDocumentFieldValueConvertContextExtension<HibernateOrmMappingContext>, ToDocumentValueConvertContextExtension<HibernateOrmMappingContext>, IdentifierBridgeFromDocumentIdentifierContextExtension<HibernateOrmSessionContext>, IdentifierBridgeToDocumentIdentifierContextExtension<HibernateOrmMappingContext>, PropertyBridgeWriteContextExtension<HibernateOrmSessionContext>, RoutingBridgeRouteContextExtension<HibernateOrmSessionContext>, TypeBridgeWriteContextExtension<HibernateOrmSessionContext>, ValueBridgeFromIndexedValueContextExtension<HibernateOrmSessionContext>, ValueBridgeToIndexedValueContextExtension<HibernateOrmMappingContext>

public final class HibernateOrmExtension
extends Object
implements IdentifierBridgeToDocumentIdentifierContextExtension<HibernateOrmMappingContext>, IdentifierBridgeFromDocumentIdentifierContextExtension<HibernateOrmSessionContext>, RoutingBridgeRouteContextExtension<HibernateOrmSessionContext>, TypeBridgeWriteContextExtension<HibernateOrmSessionContext>, PropertyBridgeWriteContextExtension<HibernateOrmSessionContext>, ValueBridgeToIndexedValueContextExtension<HibernateOrmMappingContext>, ValueBridgeFromIndexedValueContextExtension<HibernateOrmSessionContext>, ToDocumentFieldValueConvertContextExtension<HibernateOrmMappingContext>, ToDocumentValueConvertContextExtension<HibernateOrmMappingContext>, FromDocumentFieldValueConvertContextExtension<HibernateOrmSessionContext>, FromDocumentValueConvertContextExtension<HibernateOrmSessionContext>

An extension for the Hibernate ORM mapper, giving access to Hibernate ORM-specific contexts.

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 directly by users. In short, users are only expected to get instances of this type from an API and pass it to another API.

See Also:

get()

Method Summary

Modifier and Type	Method	Description
Optional<HibernateOrmSessionContext>	extendOptional(FromDocumentFieldValueConvertContext original, BackendSessionContext sessionContext)	Deprecated. Use FromDocumentValueConverter and FromDocumentValueConvertContext instead.
Optional<HibernateOrmSessionContext>	extendOptional(FromDocumentValueConvertContext original, BackendSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmMappingContext>	extendOptional(ToDocumentFieldValueConvertContext original, BackendMappingContext mappingContext)	Deprecated. Use ToDocumentFieldValueConverter and ToDocumentFieldValueConvertContext instead.
Optional<HibernateOrmMappingContext>	extendOptional(ToDocumentValueConvertContext original, BackendMappingContext mappingContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmSessionContext>	extendOptional(IdentifierBridgeFromDocumentIdentifierContext original, BridgeSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmMappingContext>	extendOptional(IdentifierBridgeToDocumentIdentifierContext original, BridgeMappingContext mappingContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmSessionContext>	extendOptional(PropertyBridgeWriteContext original, BridgeSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmSessionContext>	extendOptional(RoutingBridgeRouteContext original, BridgeSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmSessionContext>	extendOptional(TypeBridgeWriteContext original, BridgeSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmSessionContext>	extendOptional(ValueBridgeFromIndexedValueContext original, BridgeSessionContext sessionContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
Optional<HibernateOrmMappingContext>	extendOptional(ValueBridgeToIndexedValueContext original, BridgeMappingContext mappingContext)	Attempt to extend a given context, returning an empty Optional in case of failure.
static HibernateOrmExtension	get()

Methods inherited from class java.lang.Object

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

Method Detail

get

public static HibernateOrmExtension get()

extendOptional

public Optional<HibernateOrmMappingContext> extendOptional(IdentifierBridgeToDocumentIdentifierContext original,
                                                           BridgeMappingContext mappingContext)

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 IdentifierBridgeToDocumentIdentifierContextExtension<HibernateOrmMappingContext>

Parameters:

original - The original, non-extended IdentifierBridgeToDocumentIdentifierContext.

mappingContext - A BridgeMappingContext.

Returns:

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

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(IdentifierBridgeFromDocumentIdentifierContext original,
                                                           BridgeSessionContext sessionContext)

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 IdentifierBridgeFromDocumentIdentifierContextExtension<HibernateOrmSessionContext>

Parameters:

original - The original, non-extended IdentifierBridgeFromDocumentIdentifierContext.

sessionContext - A BridgeSessionContext.

Returns:

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

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(RoutingBridgeRouteContext original,
                                                           BridgeSessionContext sessionContext)

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 RoutingBridgeRouteContextExtension<HibernateOrmSessionContext>

Parameters:

original - The original, non-extended RoutingBridgeRouteContext.

sessionContext - A BridgeSessionContext.

Returns:

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

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(TypeBridgeWriteContext original,
                                                           BridgeSessionContext sessionContext)

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 TypeBridgeWriteContextExtension<HibernateOrmSessionContext>

Parameters:

original - The original, non-extended TypeBridgeWriteContext.

sessionContext - A BridgeSessionContext.

Returns:

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

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(PropertyBridgeWriteContext original,
                                                           BridgeSessionContext sessionContext)

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 PropertyBridgeWriteContextExtension<HibernateOrmSessionContext>

Parameters:

original - The original, non-extended PropertyBridgeWriteContext.

sessionContext - A BridgeSessionContext.

Returns:

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

extendOptional

public Optional<HibernateOrmMappingContext> extendOptional(ValueBridgeToIndexedValueContext original,
                                                           BridgeMappingContext mappingContext)

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 ValueBridgeToIndexedValueContextExtension<HibernateOrmMappingContext>

Parameters:

original - The original, non-extended ValueBridgeToIndexedValueContext.

mappingContext - A BridgeMappingContext.

Returns:

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

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(ValueBridgeFromIndexedValueContext original,
                                                           BridgeSessionContext sessionContext)

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 ValueBridgeFromIndexedValueContextExtension<HibernateOrmSessionContext>

Parameters:

original - The original, non-extended ValueBridgeToIndexedValueContext.

sessionContext - A BridgeSessionContext.

Returns:

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

extendOptional

@Deprecated
public Optional<HibernateOrmMappingContext> extendOptional(ToDocumentFieldValueConvertContext original,
                                                           BackendMappingContext mappingContext)

Deprecated.

Use ToDocumentFieldValueConverter and ToDocumentFieldValueConvertContext instead.

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 ToDocumentFieldValueConvertContextExtension<HibernateOrmMappingContext>

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.

extendOptional

public Optional<HibernateOrmMappingContext> extendOptional(ToDocumentValueConvertContext original,
                                                           BackendMappingContext mappingContext)

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 ToDocumentFieldValueConvertContextExtension<HibernateOrmMappingContext>

Specified by:

extendOptional in interface ToDocumentValueConvertContextExtension<HibernateOrmMappingContext>

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

@Deprecated
public Optional<HibernateOrmSessionContext> extendOptional(FromDocumentFieldValueConvertContext original,
                                                           BackendSessionContext sessionContext)

Deprecated.

Use FromDocumentValueConverter and FromDocumentValueConvertContext instead.

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 FromDocumentFieldValueConvertContextExtension<HibernateOrmSessionContext>

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.

extendOptional

public Optional<HibernateOrmSessionContext> extendOptional(FromDocumentValueConvertContext original,
                                                           BackendSessionContext sessionContext)

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 FromDocumentFieldValueConvertContextExtension<HibernateOrmSessionContext>

Specified by:

extendOptional in interface FromDocumentValueConvertContextExtension<HibernateOrmSessionContext>

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.