Package org.hibernate.search.engine.search.sort.dsl.impl

Class SearchSortFactoryExtensionStep

java.lang.Object

org.hibernate.search.engine.search.sort.dsl.impl.SearchSortFactoryExtensionStep

All Implemented Interfaces:

SearchSortFactoryExtensionIfSupportedMoreStep, SearchSortFactoryExtensionIfSupportedStep

public final class SearchSortFactoryExtensionStep
extends Object
implements SearchSortFactoryExtensionIfSupportedMoreStep

Constructor Summary

Constructors

Constructor	Description
SearchSortFactoryExtensionStep(SearchSortFactory parent, SearchSortDslContext<?,?> dslContext)

Method Summary

Modifier and Type	Method	Description
<T> SearchSortFactoryExtensionIfSupportedMoreStep	ifSupported(SearchSortFactoryExtension<T> extension, Function<T,? extends SortFinalStep> sortContributor)	If the given extension is supported, and none of the previous extensions passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported, extend the current factory with this extension, apply the given function to the extended factory, and store the resulting sort for later retrieval.
SortThenStep	orElse(Function<SearchSortFactory,? extends SortFinalStep> sortContributor)	If no extension passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchSortFactory; otherwise return the sort created in the first succeeding ifSupported call.
SortThenStep	orElseFail()	If no extension passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported so far, throw an exception; otherwise return the sort created in the first succeeding ifSupported call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchSortFactoryExtensionStep

public SearchSortFactoryExtensionStep(SearchSortFactory parent,
                                      SearchSortDslContext<?,?> dslContext)

Method Detail

ifSupported

public <T> SearchSortFactoryExtensionIfSupportedMoreStep ifSupported(SearchSortFactoryExtension<T> extension,
                                                                     Function<T,? extends SortFinalStep> sortContributor)

Description copied from interface: SearchSortFactoryExtensionIfSupportedStep

If the given extension is supported, and none of the previous extensions passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported, extend the current factory with this extension, apply the given function to the extended factory, and store the resulting sort for later retrieval.

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

Specified by:

ifSupported in interface SearchSortFactoryExtensionIfSupportedStep

Type Parameters:

T - The type of the extended factory.

Parameters:

extension - The extension to apply.

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

Returns:

this, for method chaining.

orElse

public SortThenStep orElse(Function<SearchSortFactory,? extends SortFinalStep> sortContributor)

Description copied from interface: SearchSortFactoryExtensionIfSupportedMoreStep

If no extension passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchSortFactory; otherwise return the sort created in the first succeeding ifSupported call.

Specified by:

orElse in interface SearchSortFactoryExtensionIfSupportedMoreStep

Parameters:

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

Returns:

The final step in the DSL of the resulting sort.

orElseFail

public SortThenStep orElseFail()

Description copied from interface: SearchSortFactoryExtensionIfSupportedMoreStep

If no extension passed to SearchSortFactoryExtensionIfSupportedStep.ifSupported(SearchSortFactoryExtension, Function) was supported so far, throw an exception; otherwise return the sort created in the first succeeding ifSupported call.

Specified by:

orElseFail in interface SearchSortFactoryExtensionIfSupportedMoreStep

Returns:

The final step in the DSL of the resulting sort.