SearchPredicateFactoryExtensionIfSupportedStep (Hibernate Search 8.0.0.Final)

All Known Subinterfaces:: SearchPredicateFactoryExtensionIfSupportedMoreStep<SR>

public interface SearchPredicateFactoryExtensionIfSupportedStep<SR>

The initial step when attempting to apply multiple extensions to a TypedSearchPredicateFactory.

See Also:

Method Summary

Modifier and Type

Method

Description

<T> SearchPredicateFactoryExtensionIfSupportedMoreStep<SR>

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

If the given extension is supported, and none of the previous extensions passed to ifSupported(TypedSearchPredicateFactoryExtension, 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.

Method Details
- ifSupported
  
  <T> SearchPredicateFactoryExtensionIfSupportedMoreStep<SR> ifSupported(SearchPredicateFactoryExtension<T> extension, Function<T,? extends PredicateFinalStep> predicateContributor)
  
  If the given extension is supported, and none of the previous extensions passed to ifSupported(TypedSearchPredicateFactoryExtension, 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().
  
  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.