Package org.hibernate.search.mapper.pojo.bridge.binding

Interface IdentifierBindingContext<I>

Type Parameters:

I - The type of identifiers on the POJO side of the bridge.

All Superinterfaces:

BindingContext

public interface IdentifierBindingContext<I>
extends BindingContext

The context provided to the IdentifierBinder.bind(IdentifierBindingContext) method.

Method Summary

Modifier and Type	Method	Description
<I2> void	bridge(Class<I2> expectedIdentifierType, BeanHolder<? extends IdentifierBridge<I2>> bridgeHolder)	Sets the bridge implementing the value/index binding.
<I2> void	bridge(Class<I2> expectedIdentifierType, IdentifierBridge<I2> bridge)	Sets the bridge implementing the value/index binding.
PojoModelValue<I>	bridgedElement()
default PojoModelValue<I>	getBridgedElement()	Deprecated. Use bridgedElement() instead.
default <I2> void	setBridge(Class<I2> expectedIdentifierType, BeanHolder<? extends IdentifierBridge<I2>> bridgeHolder)	Deprecated. Use bridge(Class, BeanHolder) instead.
default <I2> void	setBridge(Class<I2> expectedIdentifierType, IdentifierBridge<I2> bridge)	Deprecated. Use bridge(Class, IdentifierBridge) instead.

Methods inherited from interface org.hibernate.search.mapper.pojo.bridge.binding.BindingContext

beanResolver, getBeanResolver

Method Detail

bridge

<I2> void bridge(Class<I2> expectedIdentifierType,
                 IdentifierBridge<I2> bridge)

Sets the bridge implementing the value/index binding.

Type Parameters:

I2 - The type of identifiers expected by the given bridge.

Parameters:

expectedIdentifierType - The type of identifiers expected by the given bridge. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

bridge - The bridge to use at runtime to convert between the POJO identifier and the document identifier.

setBridge

@Deprecated
default <I2> void setBridge(Class<I2> expectedIdentifierType,
                            IdentifierBridge<I2> bridge)

Deprecated.

Use bridge(Class, IdentifierBridge) instead.

Sets the bridge implementing the value/index binding.

Type Parameters:

I2 - The type of identifiers expected by the given bridge.

Parameters:

expectedIdentifierType - The type of identifiers expected by the given bridge. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

bridge - The bridge to use at runtime to convert between the POJO identifier and the document identifier.

bridge

<I2> void bridge(Class<I2> expectedIdentifierType,
                 BeanHolder<? extends IdentifierBridge<I2>> bridgeHolder)

Sets the bridge implementing the value/index binding.

Type Parameters:

I2 - The type of identifiers expected by the given bridge.

Parameters:

expectedIdentifierType - The type of values expected by the given bridge. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

bridgeHolder - A BeanHolder containing the bridge to use at runtime to convert between the POJO property value and the index field value. Use BeanHolder.of(Object) if you don't need any particular closing behavior.

setBridge

@Deprecated
default <I2> void setBridge(Class<I2> expectedIdentifierType,
                            BeanHolder<? extends IdentifierBridge<I2>> bridgeHolder)

Deprecated.

Use bridge(Class, BeanHolder) instead.

Sets the bridge implementing the value/index binding.

Type Parameters:

I2 - The type of identifiers expected by the given bridge.

Parameters:

expectedIdentifierType - The type of values expected by the given bridge. Hibernate Search will check that these expectations are met, and throw an exception if they are not.

bridgeHolder - A BeanHolder containing the bridge to use at runtime to convert between the POJO property value and the index field value. Use BeanHolder.of(Object) if you don't need any particular closing behavior.

bridgedElement

@Incubating
PojoModelValue<I> bridgedElement()

Returns:

An entry point allowing to inspect the type of values that will be passed to this bridge.

getBridgedElement

@Deprecated
default PojoModelValue<I> getBridgedElement()

Deprecated.

Use bridgedElement() instead.

Returns:

An entry point allowing to inspect the type of values that will be passed to this bridge.