Package org.hibernate.search.engine.search.predicate.factories

Interface NamedPredicateProviderContext

@Incubating
public interface NamedPredicateProviderContext

The context passed to NamedPredicateProvider.create(NamedPredicateProviderContext).

See Also:

• NamedPredicateProvider.create(NamedPredicateProviderContext)

Method Summary

Modifier and Type	Method	Description
Object	param(String name)
Optional<Object>	paramOptional(String name)
SearchPredicateFactory	predicate()

Method Details

predicate

SearchPredicateFactory predicate()

Returns:

A predicate factory. If the named predicate was registered on an object field, this factory expects field paths to be provided relative to that same object field. This factory is only valid in the present context and must not be used after NamedPredicateProvider.create(NamedPredicateProviderContext) returns.

See Also:

• SearchPredicateFactory

param

Object param(String name)

Parameters:

name - The name of the parameter.

Returns:

The value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter.

Throws:

SearchException - no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)

paramOptional

Optional<Object> paramOptional(String name)

Parameters:

name - The name of the parameter.

Returns:

An optional containing the value provided to NamedPredicateOptionsStep.param(String, Object) for this parameter, or Optional.empty() if no value was provided for this parameter.

See Also:

• NamedPredicateOptionsStep.param(String, Object)