Package org.apache.juneau.commons.beanquery

Class BeanQuerySyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.commons.BasicRuntimeException

org.apache.juneau.commons.beanquery.BeanQuerySyntaxException

All Implemented Interfaces:

Serializable

public class BeanQuerySyntaxException
extends BasicRuntimeException

Thrown when a $-search expression names an unknown operator or is otherwise malformed (an unclosed parenthesis, a wrong argument count, junk after the close paren, an empty expression, and so on), or when a higher-level check (column allow-list, sort keys, paging, regex policy, operator/type mismatch, an unparseable typed value) rejects a caller-supplied query.

The single public parser (SearchExpressionParser) throws this for every syntactic problem; the #1/#2 validation pipeline throws it for every semantic one. Every instance carries a stable BeanQuerySyntaxException.Code: messages are for people, code() is for callers (an HTTP error body, the JS engine, a test corpus) that need to branch on *which* problem occurred without parsing the message.

Example:

try { SearchExpressionParser.parse("$foo(1)", SearchOperatorSet.standard()); } catch (BeanQuerySyntaxException e) { if (e.code() == BeanQuerySyntaxException.Code.UNKNOWN_OPERATOR) log.warn("Unknown operator: {}", e.getMessage()); }

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BeanQuerySyntaxException.Code	Stable identity for a BeanQuerySyntaxException, independent of the (free-text) message.

Constructor Summary

Constructors

Constructor	Description
BeanQuerySyntaxException(BeanQuerySyntaxException.Code code, String message, Object... args)	Constructor.

Method Summary

Modifier and Type	Method	Description
BeanQuerySyntaxException.Code	code()	Returns the stable code identifying which problem occurred.

Methods inherited from class org.apache.juneau.commons.BasicRuntimeException

getMessage, setMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BeanQuerySyntaxException

public BeanQuerySyntaxException(BeanQuerySyntaxException.Code code,
 String message,
 Object... args)

Constructor.

Parameters:

code - The stable BeanQuerySyntaxException.Code identifying which problem occurred. Must not be null.

message - The String.format-style message (%s placeholders).

args - Optional String.format-style arguments.

Method Details

code

public BeanQuerySyntaxException.Code code()

Returns the stable code identifying which problem occurred.

Returns:

The code, never null.