Interface JpaJsonQueryNode

All Known Subinterfaces:

JpaJsonQueryExpression

All Known Implementing Classes:

SqmJsonQueryExpression

@Incubating(since="6.3")
public interface JpaJsonQueryNode

The base for json_query function nodes.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	JpaJsonQueryNode.EmptyBehavior	The behavior of the json query expression when a JSON path does not resolve for a JSON document.
static enum	JpaJsonQueryNode.ErrorBehavior	The behavior of the json query expression when a JSON processing error occurs.
static enum	JpaJsonQueryNode.WrapMode	The kind of wrapping to apply to the results of the query.

Method Summary

Modifier and Type	Method	Description
JpaJsonQueryNode	emptyArrayOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.
JpaJsonQueryNode	emptyArrayOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.
JpaJsonQueryNode	emptyObjectOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.
JpaJsonQueryNode	emptyObjectOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.
JpaJsonQueryNode	errorOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.
JpaJsonQueryNode	errorOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.
JpaJsonQueryNode.EmptyBehavior	getEmptyBehavior()	Get the JpaJsonQueryNode.EmptyBehavior of this json query expression.
JpaJsonQueryNode.ErrorBehavior	getErrorBehavior()	Get the JpaJsonQueryNode.ErrorBehavior of this json query expression.
JpaJsonQueryNode.WrapMode	getWrapMode()	Get the JpaJsonQueryNode.WrapMode of this json query expression.
JpaJsonQueryNode	nullOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.
JpaJsonQueryNode	nullOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.
JpaJsonQueryNode	unspecifiedOnEmpty()	Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.
JpaJsonQueryNode	unspecifiedOnError()	Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.
JpaJsonQueryNode	unspecifiedWrapper()	Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.
JpaJsonQueryNode	withConditionalWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.
JpaJsonQueryNode	withoutWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.
JpaJsonQueryNode	withWrapper()	Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Method Details

getWrapMode

@Nonnull
JpaJsonQueryNode.WrapMode getWrapMode()

Get the JpaJsonQueryNode.WrapMode of this json query expression.

Returns:

the wrap mode

getErrorBehavior

@Nonnull
JpaJsonQueryNode.ErrorBehavior getErrorBehavior()

Get the JpaJsonQueryNode.ErrorBehavior of this json query expression.

Returns:

the error behavior

getEmptyBehavior

@Nonnull
JpaJsonQueryNode.EmptyBehavior getEmptyBehavior()

Get the JpaJsonQueryNode.EmptyBehavior of this json query expression.

Returns:

the empty behavior

withoutWrapper

@Nonnull
JpaJsonQueryNode withoutWrapper()

Sets the JpaJsonQueryNode.WrapMode.WITHOUT_WRAPPER for this json query expression.

Returns:

this for method chaining

withWrapper

@Nonnull
JpaJsonQueryNode withWrapper()

Sets the JpaJsonQueryNode.WrapMode.WITH_WRAPPER for this json query expression.

Returns:

this for method chaining

withConditionalWrapper

@Nonnull
JpaJsonQueryNode withConditionalWrapper()

Sets the JpaJsonQueryNode.WrapMode.WITH_CONDITIONAL_WRAPPER for this json query expression.

Returns:

this for method chaining

unspecifiedWrapper

@Nonnull
JpaJsonQueryNode unspecifiedWrapper()

Sets the JpaJsonQueryNode.WrapMode.UNSPECIFIED for this json query expression.

Returns:

this for method chaining

unspecifiedOnError

@Nonnull
JpaJsonQueryNode unspecifiedOnError()

Sets the JpaJsonQueryNode.ErrorBehavior.UNSPECIFIED for this json query expression.

Returns:

this for method chaining

errorOnError

@Nonnull
JpaJsonQueryNode errorOnError()

Sets the JpaJsonQueryNode.ErrorBehavior.ERROR for this json query expression.

Returns:

this for method chaining

nullOnError

@Nonnull
JpaJsonQueryNode nullOnError()

Sets the JpaJsonQueryNode.ErrorBehavior.NULL for this json query expression.

Returns:

this for method chaining

emptyArrayOnError

@Nonnull
JpaJsonQueryNode emptyArrayOnError()

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_ARRAY for this json query expression.

Returns:

this for method chaining

emptyObjectOnError

@Nonnull
JpaJsonQueryNode emptyObjectOnError()

Sets the JpaJsonQueryNode.ErrorBehavior.EMPTY_OBJECT for this json query expression.

Returns:

this for method chaining

unspecifiedOnEmpty

@Nonnull
JpaJsonQueryNode unspecifiedOnEmpty()

Sets the JpaJsonQueryNode.EmptyBehavior.UNSPECIFIED for this json query expression.

Returns:

this for method chaining

errorOnEmpty

@Nonnull
JpaJsonQueryNode errorOnEmpty()

Sets the JpaJsonQueryNode.EmptyBehavior.ERROR for this json query expression.

Returns:

this for method chaining

nullOnEmpty

@Nonnull
JpaJsonQueryNode nullOnEmpty()

Sets the JpaJsonQueryNode.EmptyBehavior.NULL for this json query expression.

Returns:

this for method chaining

emptyArrayOnEmpty

@Nonnull
JpaJsonQueryNode emptyArrayOnEmpty()

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_ARRAY for this json query expression.

Returns:

this for method chaining

emptyObjectOnEmpty

@Nonnull
JpaJsonQueryNode emptyObjectOnEmpty()

Sets the JpaJsonQueryNode.EmptyBehavior.EMPTY_OBJECT for this json query expression.

Returns:

this for method chaining