Module tools.jackson.core

Package tools.jackson.core

Class JacksonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

tools.jackson.core.JacksonException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JacksonIOException, StreamConstraintsException, StreamReadException, StreamWriteException

public class JacksonException
extends RuntimeException

Base class for all Jackson-produced checked exceptions.

Note that in Jackson 2.x this exception extended IOException but in 3.x RuntimeException

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JacksonException.Reference	Simple bean class used to contain references.

Field Summary

Fields

Modifier and Type	Field	Description
protected TokenStreamLocation	_location
protected LinkedList<JacksonException.Reference>	_path	Path through which problem that triggering throwing of this exception was reached.
protected Closeable	_processor	Underlying processor (JsonParser or JsonGenerator), if known.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JacksonException(Closeable processor, String msg)
protected	JacksonException(Closeable processor, String msg, Throwable problem)
protected	JacksonException(Closeable processor, String msg, TokenStreamLocation loc)
protected	JacksonException(Closeable processor, String msg, TokenStreamLocation loc, Throwable rootCause)
protected	JacksonException(Closeable processor, Throwable rootCause)
protected	JacksonException(String msg)
protected	JacksonException(String msg, Throwable rootCause)
protected	JacksonException(String msg, TokenStreamLocation loc, Throwable rootCause)
protected	JacksonException(Throwable rootCause)

Method Summary

Modifier and Type	Method	Description
protected StringBuilder	_appendPathDesc(StringBuilder sb)
protected StringBuilder	_appendReferenceChain(StringBuilder sb)
protected String	_buildMessage()	Default method overridden so that we can add location information
static String	_exceptionMessage(Throwable t)
JacksonException	clearLocation()	Method that allows to remove context information from this exception's message.
String	getLocalizedMessage()
TokenStreamLocation	getLocation()	Accessor for location information related to position within input or output (depending on operation), if available; if not available may return TokenStreamLocation.NA (but never null).
String	getMessage()	Method is overridden so that we can properly inject description of problem path, if such is defined.
String	getOriginalMessage()	Method that allows accessing the original "message" argument, without additional decorations (like location information) that overridden getMessage() adds.
List<JacksonException.Reference>	getPath()	Method for accessing full structural path within type hierarchy down to problematic property.
String	getPathReference()	Method for accessing description of path that lead to the problem that triggered this exception
StringBuilder	getPathReference(StringBuilder sb)
protected String	messageSuffix()	Accessor that sub-classes can override to append additional information right after the main message, but before source location information.
JacksonException	prependPath(Object referrer, int index)	Method called to prepend a reference information in front of current path
JacksonException	prependPath(Object referrer, String propertyName)	Method called to prepend a reference information in front of current path
JacksonException	prependPath(JacksonException.Reference r)
Object	processor()	Method that allows accessing underlying processor that triggered this exception; typically either JsonParser or JsonGenerator for exceptions that originate from streaming API, but may be other types when thrown by databinding.
String	toString()
JacksonException	withCause(Throwable cause)
static JacksonException	wrapWithPath(Throwable src, Object refFrom, int index)	Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information.
static JacksonException	wrapWithPath(Throwable src, Object refFrom, String refPropertyName)	Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information.
static JacksonException	wrapWithPath(Throwable src, JacksonException.Reference ref)	Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information.
static JacksonException	wrapWithPath(Throwable src, JacksonException.Reference ref, BiFunction<String,Throwable,JacksonException> ctor)

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Details

_location

protected TokenStreamLocation _location

_path

protected LinkedList<JacksonException.Reference> _path

Path through which problem that triggering throwing of this exception was reached.

_processor

protected transient Closeable _processor

Underlying processor (JsonParser or JsonGenerator), if known.

NOTE: typically not serializable hence transient

Constructor Details

JacksonException

protected JacksonException(String msg)

JacksonException

protected JacksonException(Throwable rootCause)

JacksonException

protected JacksonException(String msg,
 Throwable rootCause)

JacksonException

protected JacksonException(String msg,
 TokenStreamLocation loc,
 Throwable rootCause)

JacksonException

protected JacksonException(Closeable processor,
 Throwable rootCause)

JacksonException

protected JacksonException(Closeable processor,
 String msg,
 TokenStreamLocation loc,
 Throwable rootCause)

JacksonException

protected JacksonException(Closeable processor,
 String msg)

JacksonException

protected JacksonException(Closeable processor,
 String msg,
 Throwable problem)

JacksonException

protected JacksonException(Closeable processor,
 String msg,
 TokenStreamLocation loc)

Method Details

withCause

public JacksonException withCause(Throwable cause)

clearLocation

public JacksonException clearLocation()

Method that allows to remove context information from this exception's message. Useful when you are parsing security-sensitive data and don't want original data excerpts to be present in Jackson parser error messages.

Returns:

This exception instance to allow call chaining

wrapWithPath

public static JacksonException wrapWithPath(Throwable src,
 Object refFrom,
 String refPropertyName)

Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information. This version of method is called when the reference is through a non-indexed object, such as a Map or POJO/bean.

wrapWithPath

public static JacksonException wrapWithPath(Throwable src,
 Object refFrom,
 int index)

Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information. This version of method is called when the reference is through an index, which happens with arrays and Collections.

wrapWithPath

public static JacksonException wrapWithPath(Throwable src,
 JacksonException.Reference ref)

Method that can be called to either create a new JacksonException (if underlying exception is not a JacksonException), or augment given exception with given path/reference information.

wrapWithPath

public static JacksonException wrapWithPath(Throwable src,
 JacksonException.Reference ref,
 BiFunction<String,Throwable,JacksonException> ctor)

_exceptionMessage

public static String _exceptionMessage(Throwable t)

prependPath

public JacksonException prependPath(Object referrer,
 String propertyName)

Method called to prepend a reference information in front of current path

prependPath

public JacksonException prependPath(Object referrer,
 int index)

Method called to prepend a reference information in front of current path

prependPath

public JacksonException prependPath(JacksonException.Reference r)

getPath

public List<JacksonException.Reference> getPath()

Method for accessing full structural path within type hierarchy down to problematic property.

getPathReference

public String getPathReference()

Method for accessing description of path that lead to the problem that triggered this exception

getPathReference

public StringBuilder getPathReference(StringBuilder sb)

getLocation

public TokenStreamLocation getLocation()

Accessor for location information related to position within input or output (depending on operation), if available; if not available may return TokenStreamLocation.NA (but never null).

Accuracy of location information depends on backend (format) as well as (in some cases) operation being performed.

Returns:

Location in input or output that triggered the problem reported, if available; null otherwise.

getOriginalMessage

public String getOriginalMessage()

Method that allows accessing the original "message" argument, without additional decorations (like location information) that overridden getMessage() adds.

Returns:

Original, unmodified message argument used to construct this exception instance

processor

public Object processor()

Method that allows accessing underlying processor that triggered this exception; typically either JsonParser or JsonGenerator for exceptions that originate from streaming API, but may be other types when thrown by databinding.

Note that it is possible that null may be returned if code throwing exception either has no access to the processor; or has not been retrofitted to set it; this means that caller needs to take care to check for nulls. Subtypes override this method with co-variant return type, for more type-safe access.

NOTE: In Jackson 2.x, accessor was getProcessor(): in 3.0 changed to non-getter to avoid having to annotate for serialization.

Returns:

Originating processor, if available; null if not.

messageSuffix

protected String messageSuffix()

Accessor that sub-classes can override to append additional information right after the main message, but before source location information.

NOTE: In Jackson 2.x, accessor was getMessageSuffix(): in 3.0 changed to non-getter to indicate it is not a "regular" getter (although it would not be serialized anyway due to lower visibility).

Returns:

Message suffix configured to be used, if any; null if none

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getMessage

public String getMessage()

Method is overridden so that we can properly inject description of problem path, if such is defined.

Overrides:

getMessage in class Throwable

_buildMessage

protected String _buildMessage()

Default method overridden so that we can add location information

Returns:

Message constructed based on possible optional prefix; explicit message passed to constructor as well trailing location description (separate from message by linefeed)

toString

public String toString()

Overrides:

toString in class Throwable

_appendReferenceChain

protected StringBuilder _appendReferenceChain(StringBuilder sb)

_appendPathDesc

protected StringBuilder _appendPathDesc(StringBuilder sb)