org.hibernate.search.engine.search.predicate.dsl

Interface SearchPredicateFactoryExtension<T>

Type Parameters:

T - The type of extended predicate factories. Should generally extend SearchPredicateFactory.

public interface SearchPredicateFactoryExtension<T>

An extension to the search predicate DSL, allowing the use of non-standard predicates in a query.

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:

SearchPredicateFactory.extension(SearchPredicateFactoryExtension), DelegatingSearchPredicateFactory

Method Summary

Modifier and Type	Method and Description
<C,B> Optional<T>	extendOptional(SearchPredicateFactory original, SearchPredicateBuilderFactory<C,B> factory) Attempt to extend a given factory, returning an empty Optional in case of failure.

Method Detail

extendOptional

<C,B> Optional<T> extendOptional(SearchPredicateFactory original,
                                 SearchPredicateBuilderFactory<C,B> factory)

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

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

Type Parameters:

C - The type of query element collector for the given predicate builder factory.

B - The implementation type of builders for the given predicate builder factory.

Parameters:

original - The original, non-extended SearchPredicateFactory.

factory - A SearchPredicateBuilderFactory.

Returns:

An optional containing the extended search predicate factory (T) in case of success, or an empty optional otherwise.