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

Interface SearchSortFactoryExtensionContext

public interface SearchSortFactoryExtensionContext

The context used when attempting to apply multiple extensions to a SearchSortFactoryContext.

See Also:

SearchSortFactoryContext.extension()

Method Summary

Modifier and Type	Method and Description
<T> SearchSortFactoryExtensionContext	ifSupported(SearchSortFactoryContextExtension<T> extension, Function<T,? extends SearchSortTerminalContext> sortContributor) If the given extension is supported, and none of the previous extensions passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported, extend the current context with this extension, and apply the given consumer to the extended context.
NonEmptySortContext	orElse(Function<SearchSortFactoryContext,? extends SearchSortTerminalContext> sortContributor) If no extension passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchSortFactoryContext; otherwise do nothing.
NonEmptySortContext	orElseFail() If no extension passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported so far, throw an exception; otherwise do nothing.

Method Detail

ifSupported

<T> SearchSortFactoryExtensionContext ifSupported(SearchSortFactoryContextExtension<T> extension,
                                                  Function<T,? extends SearchSortTerminalContext> sortContributor)

If the given extension is supported, and none of the previous extensions passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported, extend the current context with this extension, and apply the given consumer to the extended context.

This method cannot be called after orElse(Function) or orElseFail().

Type Parameters:

T - The type of the extended context.

Parameters:

extension - The extension to apply.

sortContributor - A function called if the extension is successfully applied; it will use the (extended) DSL context passed in parameter to create a sort, returning the resulting terminal context. Should generally be a lambda expression.

Returns:

this, for method chaining.

orElse

NonEmptySortContext orElse(Function<SearchSortFactoryContext,? extends SearchSortTerminalContext> sortContributor)

If no extension passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchSortFactoryContext; otherwise do nothing.

Parameters:

sortContributor - A function called if no extension was successfully applied; it will use the (extended) DSL context passed in parameter to create a sort, returning the resulting terminal context. Should generally be a lambda expression.

Returns:

The next context.

orElseFail

NonEmptySortContext orElseFail()

If no extension passed to ifSupported(SearchSortFactoryContextExtension, Function) was supported so far, throw an exception; otherwise do nothing.

Returns:

The next context.

Throws:

SearchException - If none of the previously passed extensions was supported.