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

Interface SearchPredicateFactoryExtension<T>

Type Parameters:

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

All Known Implementing Classes:

ElasticsearchExtension, LuceneExtension

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)
• ExtendedSearchPredicateFactory

Method Summary

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

Method Details

extendOptional

Optional<T> extendOptional(SearchPredicateFactory original)

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.

Parameters:

original - The original, non-extended SearchPredicateFactory.

Returns:

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