org.hibernate.search.engine.search.dsl.sort

Interface SearchSortFactoryContextExtension<T>

Type Parameters:

T - The type of extended sort factory contexts. Should generally extend SearchSortFactoryContext.

public interface SearchSortFactoryContextExtension<T>

An extension to the search query DSL, allowing to add non-standard sorts to 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:

SearchSortFactoryContext.extension(SearchSortFactoryContextExtension), DelegatingSearchSortFactoryContext

Method Summary

Modifier and Type	Method and Description
Optional<T>	extendOptional(SearchSortFactoryContext original, SearchSortDslContext<?,?> dslContext) Attempt to extend a given context, returning an empty Optional in case of failure.

Method Detail

extendOptional

Optional<T> extendOptional(SearchSortFactoryContext original,
                           SearchSortDslContext<?,?> dslContext)

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.

Parameters:

original - The original, non-extended SearchSortFactoryContext.

dslContext - A SearchSortDslContext.

Returns:

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