Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.model.FunctionContributor

On object that contributes custom HQL functions, eventually to a org.hibernate.query.sqm.function.SqmFunctionRegistry, via an instance of FunctionContributions.

The most common way to integrate a FunctionContributor is by making it discoverable via the Java java.util.ServiceLoader facility.
Alternatively, a FunctionContributor may be programmatically supplied to org.hibernate.cfg.Configuration#registerFunctionContributor(FunctionContributor) or even org.hibernate.boot.MetadataBuilder#applyFunctions(FunctionContributor).

Method Summary

Modifier and Type	Method and Description
public void	contributeFunctions(FunctionContributions The target for the contributions functionContributions) Contribute functions
public default int	Returns: the ordinal for this FunctionContributor ordinal() Determines order in which the contributions will be applied (lowest ordinal first).

Method Detail

contributeFunctions	back to summary
public void contributeFunctions(FunctionContributions functionContributions) Contribute functions Parameters functionContributions:FunctionContributions The target for the contributions

contributeFunctions

back to summary

public void contributeFunctions(FunctionContributions functionContributions)

Contribute functions

Parameters

functionContributions:FunctionContributions: The target for the contributions

ordinal back to summary

ordinal	back to summary
public default int ordinal() Determines order in which the contributions will be applied (lowest ordinal first). The range 0-500 is reserved for Hibernate, range 500-1000 for libraries and 1000-Integer.MAX_VALUE for user-defined FunctionContributors. Contributions from higher precedence contributors (higher numbers) effectively override contributions from lower precedence. E.g. if a contributor with precedence 1000 contributes a function named `"max"`, that will override Hibernate's standard function of that name. Returns:int the ordinal for this FunctionContributor

public default int ordinal()

Determines order in which the contributions will be applied (lowest ordinal first).

The range 0-500 is reserved for Hibernate, range 500-1000 for libraries and 1000-Integer.MAX_VALUE for user-defined FunctionContributors.

Contributions from higher precedence contributors (higher numbers) effectively override contributions from lower precedence. E.g. if a contributor with precedence 1000 contributes a function named "max", that will override Hibernate's standard function of that name.

Returns:int: the ordinal for this FunctionContributor

public Interface FunctionContributor

Method Summary

Method Detail