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

Class SearchPredicateFactoryExtensionStep

java.lang.Object

org.hibernate.search.engine.search.predicate.dsl.impl.SearchPredicateFactoryExtensionStep

All Implemented Interfaces:

SearchPredicateFactoryExtensionIfSupportedMoreStep, SearchPredicateFactoryExtensionIfSupportedStep

public final class SearchPredicateFactoryExtensionStep
extends Object
implements SearchPredicateFactoryExtensionIfSupportedStep, SearchPredicateFactoryExtensionIfSupportedMoreStep

Constructor Summary

Constructors

Constructor	Description
SearchPredicateFactoryExtensionStep(SearchPredicateFactory parent)

Method Summary

Modifier and Type	Method	Description
<T> SearchPredicateFactoryExtensionIfSupportedMoreStep	ifSupported(SearchPredicateFactoryExtension<T> extension, Function<T,? extends PredicateFinalStep> predicateContributor)	If the given extension is supported, and none of the previous extensions passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported, extend the current factory with this extension, apply the given function to the extended factory, and store the resulting predicate for later retrieval.
PredicateFinalStep	orElse(Function<SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor)	If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchPredicateFactory; otherwise return the predicate created in the first succeeding ifSupported call.
PredicateFinalStep	orElseFail()	If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, throw an exception; otherwise return the predicate 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

SearchPredicateFactoryExtensionStep

public SearchPredicateFactoryExtensionStep(SearchPredicateFactory parent)

Method Detail

ifSupported

public <T> SearchPredicateFactoryExtensionIfSupportedMoreStep ifSupported(SearchPredicateFactoryExtension<T> extension,
                                                                          Function<T,? extends PredicateFinalStep> predicateContributor)

Description copied from interface: SearchPredicateFactoryExtensionIfSupportedStep

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

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

Specified by:

ifSupported in interface SearchPredicateFactoryExtensionIfSupportedStep

Type Parameters:

T - The type of the extended factory.

Parameters:

extension - The extension to apply.

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

Returns:

The next step.

orElse

public PredicateFinalStep orElse(Function<SearchPredicateFactory,? extends PredicateFinalStep> predicateContributor)

Description copied from interface: SearchPredicateFactoryExtensionIfSupportedMoreStep

If no extension passed to SearchPredicateFactoryExtensionIfSupportedStep.ifSupported(SearchPredicateFactoryExtension, Function) was supported so far, apply the given consumer to the current (non-extended) SearchPredicateFactory; otherwise return the predicate created in the first succeeding ifSupported call.

Specified by:

orElse in interface SearchPredicateFactoryExtensionIfSupportedMoreStep

Parameters:

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

Returns:

The final step in the DSL of the resulting predicate.

orElseFail

public PredicateFinalStep orElseFail()

Description copied from interface: SearchPredicateFactoryExtensionIfSupportedMoreStep

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

Specified by:

orElseFail in interface SearchPredicateFactoryExtensionIfSupportedMoreStep

Returns:

The final step in the DSL of the resulting predicate.