Interface JpaJsonValueNode<T>

All Known Subinterfaces:

JpaJsonValueExpression<T>

All Known Implementing Classes:

SqmJsonValueExpression

@Incubating(since="6.3")
public interface JpaJsonValueNode<T>

The base for json_value function nodes.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	JpaJsonValueNode.EmptyBehavior	The behavior of the json value expression when a JSON path does not resolve for a JSON document.
static enum	JpaJsonValueNode.ErrorBehavior	The behavior of the json value expression when a JSON processing error occurs.

Method Summary

Modifier and Type	Method	Description
JpaJsonValueNode<T>	defaultOnEmpty(Expression<?> expression)	Sets the JpaJsonValueNode.EmptyBehavior.DEFAULT for this json value expression.
JpaJsonValueNode<T>	defaultOnError(Expression<?> expression)	Sets the JpaJsonValueNode.ErrorBehavior.DEFAULT for this json value expression.
JpaJsonValueNode<T>	errorOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.ERROR for this json value expression.
JpaJsonValueNode<T>	errorOnError()	Sets the JpaJsonValueNode.ErrorBehavior.ERROR for this json value expression.
JpaJsonValueNode.EmptyBehavior	getEmptyBehavior()	Get the JpaJsonValueNode.EmptyBehavior of this json value expression.
JpaExpression<T>	getEmptyDefault()	Get the JpaExpression that is returned when the JSON path does not resolve for a JSON document.
JpaJsonValueNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonValueNode.ErrorBehavior of this json value expression.
JpaExpression<T>	getErrorDefault()	Get the JpaExpression that is returned on a json processing error.
JpaJsonValueNode<T>	nullOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.NULL for this json value expression.
JpaJsonValueNode<T>	nullOnError()	Sets the JpaJsonValueNode.ErrorBehavior.NULL for this json value expression.
JpaJsonValueNode<T>	unspecifiedOnEmpty()	Sets the JpaJsonValueNode.EmptyBehavior.UNSPECIFIED for this json value expression.
JpaJsonValueNode<T>	unspecifiedOnError()	Sets the JpaJsonValueNode.ErrorBehavior.UNSPECIFIED for this json value expression.

Method Details

getErrorBehavior

@Nonnull
JpaJsonValueNode.ErrorBehavior getErrorBehavior()

Get the JpaJsonValueNode.ErrorBehavior of this json value expression.

Returns:

the error behavior

getEmptyBehavior

@Nonnull
JpaJsonValueNode.EmptyBehavior getEmptyBehavior()

Get the JpaJsonValueNode.EmptyBehavior of this json value expression.

Returns:

the empty behavior

getErrorDefault

@Nullable
JpaExpression<T> getErrorDefault()

Get the JpaExpression that is returned on a json processing error. Returns null if getErrorBehavior() is not JpaJsonValueNode.ErrorBehavior.DEFAULT.

Returns:

the value to return on a json processing error

getEmptyDefault

@Nullable
JpaExpression<T> getEmptyDefault()

Get the JpaExpression that is returned when the JSON path does not resolve for a JSON document. Returns null if getEmptyBehavior() is not JpaJsonValueNode.EmptyBehavior.DEFAULT.

Returns:

the value to return on a json processing error

unspecifiedOnError

@Nonnull
JpaJsonValueNode<T> unspecifiedOnError()

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

Returns:

this for method chaining

errorOnError

@Nonnull
JpaJsonValueNode<T> errorOnError()

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

Returns:

this for method chaining

nullOnError

@Nonnull
JpaJsonValueNode<T> nullOnError()

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

Returns:

this for method chaining

defaultOnError

@Nonnull
JpaJsonValueNode<T> defaultOnError(@Nonnull
 Expression<?> expression)

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

Returns:

this for method chaining

unspecifiedOnEmpty

@Nonnull
JpaJsonValueNode<T> unspecifiedOnEmpty()

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

Returns:

this for method chaining

errorOnEmpty

@Nonnull
JpaJsonValueNode<T> errorOnEmpty()

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

Returns:

this for method chaining

nullOnEmpty

@Nonnull
JpaJsonValueNode<T> nullOnEmpty()

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

Returns:

this for method chaining

defaultOnEmpty

@Nonnull
JpaJsonValueNode<T> defaultOnEmpty(@Nonnull
 Expression<?> expression)

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

Returns:

this for method chaining