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

Interface SearchSortFactoryExtension<T>

Type Parameters:

T - The type of extended sort factories. Should generally extend SearchSortFactory.

public interface SearchSortFactoryExtension<T>

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

SearchSortFactory.extension(SearchSortFactoryExtension), DelegatingSearchSortFactory

Method Summary

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

Method Detail

extendOptional

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

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 SearchSortFactory.

dslContext - A SearchSortDslContext.

Returns:

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