Package software.amazon.smithy.jmespath

Enum Class JmespathExceptionType

java.lang.Object

java.lang.Enum<JmespathExceptionType>

software.amazon.smithy.jmespath.JmespathExceptionType

All Implemented Interfaces:

Serializable, Comparable<JmespathExceptionType>, Constable

public enum JmespathExceptionType
extends Enum<JmespathExceptionType>

Defines categories of JMESPath errors. A superset of the types defined in the specification.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVALID_ARITY	The "invalid-arity" class of JMESPath errors.
INVALID_TYPE	The "invalid-type" class of JMESPath errors.
INVALID_VALUE	The "invalid-value" class of JMESPath errors.
OTHER	Any other error cause.
SYNTAX	The "syntax" class of JMESPath errors.
UNKNOWN_FUNCTION	The "unknown-function" class of JMESPath errors.

Method Summary

Modifier and Type	Method	Description
static JmespathExceptionType	fromID(String id)	Returns the corresponding enum value for one of the identifiers used in the JMESPath specification.
static JmespathExceptionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JmespathExceptionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYNTAX

public static final JmespathExceptionType SYNTAX

The "syntax" class of JMESPath errors.

"syntax" is not listed in the specification, but it is used in the compliance tests to indicate invalid expressions.

INVALID_TYPE

public static final JmespathExceptionType INVALID_TYPE

The "invalid-type" class of JMESPath errors.

INVALID_VALUE

public static final JmespathExceptionType INVALID_VALUE

The "invalid-value" class of JMESPath errors.

UNKNOWN_FUNCTION

public static final JmespathExceptionType UNKNOWN_FUNCTION

The "unknown-function" class of JMESPath errors.

INVALID_ARITY

public static final JmespathExceptionType INVALID_ARITY

The "invalid-arity" class of JMESPath errors.

OTHER

public static final JmespathExceptionType OTHER

Any other error cause.

Method Details

values

public static JmespathExceptionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JmespathExceptionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromID

public static JmespathExceptionType fromID(String id)

Returns the corresponding enum value for one of the identifiers used in the JMESPath specification.