Module org.klojang.invoke

Package org.klojang.path

Enum Class ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

org.klojang.path.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>, Constable

public enum ErrorCode
extends Enum<ErrorCode>

Symbolic constants for read/write failures.

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
EMPTY_SEGMENT	Indicates that the PathWalker encountered a null segment or an empty segment while not processing a Map.
EXCEPTION	Indicates that the PathWalker trapped an exception from underlying code.
INDEX_EXPECTED	Indicates that the PathWalker had arrived on a list or array, so expected the next segment in the Path to be an array index, but found something other than an integer.
INDEX_NOT_ALLOWED	Indicates that the PathWalker encountered an array index in the Path, but the value of the preceding path segment was something other than a list or array.
INDEX_OUT_OF_BOUNDS	Indicates that the PathWalker encountered an array index in the Path that was out of bounds for the list or array it was processing.
KEY_DESERIALIZATION_FAILED	Indicates that a KeyDeserializer failed to deserialize a path segment into a map key.
NO_SUCH_KEY	Indicates that the PathWalker encountered a segment that did not correspond to any key of the Map it was processing.
NO_SUCH_PROPERTY	Indicates that the PathWalker encountered a segment that did not correspond to any (accessible) property of the JavaBean it was processing.
NOT_MODIFIABLE	Indicates that the PathWalker attempted to modify a List or Map and the List or Map responded by throwing an UnsupportedOperationException.
TERMINAL_VALUE	Indicates that the Path continued after having reached a terminal value (like null or a primitive value) or an opaque value (like a String).
TYPE_MISMATCH	Indicates that the PathWalker could not write a value because its type was incompatible with the target property or array.
TYPE_NOT_SUPPORTED	Indicates that the PathWalker encountered a value that it doesn't know how to read or write.

Method Summary

Modifier and Type	Method	Description
static ErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ErrorCode[]	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

INDEX_EXPECTED

public static final ErrorCode INDEX_EXPECTED

Indicates that the PathWalker had arrived on a list or array, so expected the next segment in the Path to be an array index, but found something other than an integer.

INDEX_NOT_ALLOWED

public static final ErrorCode INDEX_NOT_ALLOWED

Indicates that the PathWalker encountered an array index in the Path, but the value of the preceding path segment was something other than a list or array.

INDEX_OUT_OF_BOUNDS

public static final ErrorCode INDEX_OUT_OF_BOUNDS

Indicates that the PathWalker encountered an array index in the Path that was out of bounds for the list or array it was processing.

NO_SUCH_PROPERTY

public static final ErrorCode NO_SUCH_PROPERTY

Indicates that the PathWalker encountered a segment that did not correspond to any (accessible) property of the JavaBean it was processing.

NO_SUCH_KEY

public static final ErrorCode NO_SUCH_KEY

Indicates that the PathWalker encountered a segment that did not correspond to any key of the Map it was processing. This code is only returned by the read methods of the PathWalker class. The write methods just add the key to the map.

KEY_DESERIALIZATION_FAILED

public static final ErrorCode KEY_DESERIALIZATION_FAILED

Indicates that a KeyDeserializer failed to deserialize a path segment into a map key.

EMPTY_SEGMENT

public static final ErrorCode EMPTY_SEGMENT

Indicates that the PathWalker encountered a null segment or an empty segment while not processing a Map. (null and the empty string can only possibly be valid as map keys.)

TERMINAL_VALUE

public static final ErrorCode TERMINAL_VALUE

Indicates that the Path continued after having reached a terminal value (like null or a primitive value) or an opaque value (like a String).

TYPE_NOT_SUPPORTED

public static final ErrorCode TYPE_NOT_SUPPORTED

Indicates that the PathWalker encountered a value that it doesn't know how to read or write.

TYPE_MISMATCH

public static final ErrorCode TYPE_MISMATCH

Indicates that the PathWalker could not write a value because its type was incompatible with the target property or array.

NOT_MODIFIABLE

public static final ErrorCode NOT_MODIFIABLE

Indicates that the PathWalker attempted to modify a List or Map and the List or Map responded by throwing an UnsupportedOperationException.

EXCEPTION

public static final ErrorCode EXCEPTION

Indicates that the PathWalker trapped an exception from underlying code.

Method Details

values

public static ErrorCode[] 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 ErrorCode 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