Package org.hibernate.query.criteria

Interface JpaJsonValueExpression<T>

All Superinterfaces:

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

All Known Implementing Classes:

SqmJsonValueExpression

@Incubating
public interface JpaJsonValueExpression<T>
extends JpaExpression<T>, JpaJsonValueNode<T>

A special expression for the json_value function.

Since:

7.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.criteria.JpaJsonValueNode

JpaJsonValueNode.EmptyBehavior, JpaJsonValueNode.ErrorBehavior

Method Summary

Modifier and Type	Method	Description
JpaJsonValueExpression<T>	defaultOnEmpty(Expression<?> expression)	Sets the JpaJsonValueNode.EmptyBehavior.DEFAULT for this json value expression.
JpaJsonValueExpression<T>	defaultOnError(Expression<?> expression)	Sets the JpaJsonValueNode.ErrorBehavior.DEFAULT for this json value expression.
JpaJsonValueExpression<T>	errorOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.ERROR for this json value expression.
JpaJsonValueExpression<T>	errorOnError()	Sets the JpaJsonValueNode.ErrorBehavior.ERROR for this json value expression.
JpaJsonValueExpression<T>	nullOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.NULL for this json value expression.
JpaJsonValueExpression<T>	nullOnError()	Sets the JpaJsonValueNode.ErrorBehavior.NULL for this json value expression.
JpaJsonValueExpression<T>	passing(String parameterName, Expression<?> expression)	Passes the given Expression as value for the parameter with the given name in the JSON path.
JpaJsonValueExpression<T>	unspecifiedOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.UNSPECIFIED for this json value expression.
JpaJsonValueExpression<T>	unspecifiedOnError()	Sets the JpaJsonValueNode.ErrorBehavior.UNSPECIFIED for this json value expression.

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.JpaJsonValueNode

getEmptyBehavior, getEmptyDefault, getErrorBehavior, getErrorDefault

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

passing

JpaJsonValueExpression<T> passing(String parameterName,
 Expression<?> expression)

Passes the given Expression as value for the parameter with the given name in the JSON path.

Returns:

this for method chaining

unspecifiedOnError

JpaJsonValueExpression<T> unspecifiedOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.UNSPECIFIED for this json value expression.

Specified by:

unspecifiedOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnError

JpaJsonValueExpression<T> errorOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.ERROR for this json value expression.

Specified by:

errorOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnError

JpaJsonValueExpression<T> nullOnError()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.NULL for this json value expression.

Specified by:

nullOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnError

JpaJsonValueExpression<T> defaultOnError(Expression<?> expression)

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.ErrorBehavior.DEFAULT for this json value expression.

Specified by:

defaultOnError in interface JpaJsonValueNode<T>

Returns:

this for method chaining

unspecifiedOnEmpty

JpaJsonValueExpression<T> unspecifiedOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.UNSPECIFIED for this json value expression.

Specified by:

unspecifiedOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

errorOnEmpty

JpaJsonValueExpression<T> errorOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.ERROR for this json value expression.

Specified by:

errorOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

nullOnEmpty

JpaJsonValueExpression<T> nullOnEmpty()

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.NULL for this json value expression.

Specified by:

nullOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining

defaultOnEmpty

JpaJsonValueExpression<T> defaultOnEmpty(Expression<?> expression)

Description copied from interface: JpaJsonValueNode

Sets the JpaJsonValueNode.EmptyBehavior.DEFAULT for this json value expression.

Specified by:

defaultOnEmpty in interface JpaJsonValueNode<T>

Returns:

this for method chaining