Package org.hibernate.query.criteria

Interface JpaFunction<T>

Type Parameters:

T - The type of the function result.

All Superinterfaces:

Expression<T>, JpaCriteriaNode, JpaExpression<T>, JpaSelection<T>, JpaTupleElement<T>, Selection<T>, Serializable, TupleElement<T>

All Known Subinterfaces:

SqmAggregateFunction<T>, SqmOrderedSetAggregateFunction<T>, SqmWindowFunction<T>

All Known Implementing Classes:

AbstractSqmJsonPathExpression, FormatFunction.FormatSqmFunction, InverseDistributionFunction.SelfRenderingInverseDistributionFunction, SelfRenderingSqmAggregateFunction, SelfRenderingSqmFunction, SelfRenderingSqmOrderedSetAggregateFunction, SelfRenderingSqmWindowFunction, SqmFunction, SqmJsonExistsExpression, SqmJsonQueryExpression, SqmJsonValueExpression, SqmXmlElementExpression

public interface JpaFunction<T>
extends JpaExpression<T>

Contract for expressions which model a SQL function call.

Method Summary

Modifier and Type	Method	Description
String	getFunctionName()	Retrieve the name of the function.

Methods inherited from interface org.hibernate.query.criteria.JpaExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo

Methods inherited from interface org.hibernate.query.criteria.JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement

getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Method Details

getFunctionName

String getFunctionName()

Retrieve the name of the function.

Returns:

The function name.