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

Modifier and Type	Field and Description
protected LinkedList<JsonMappingException.Reference>	_path Path through which problem that triggering throwing of this exception was reached.
protected transient Closeable	_processor Underlying processor (`JsonParser` or `JsonGenerator`), if known.
pack-priv static final int	MAX_REFS_TO_LIST Let's limit length of reference chain, to limit damage in cases of infinite recursion.
private static final long	serialVersionUID Hides com.fasterxml.jackson.databind.DatabindException.serialVersionUID.

Access	Constructor and Description
public	JsonMappingException(String msg) Deprecated Since 2.7 Use variant that takes `JsonParser` instead
public	JsonMappingException(String msg, Throwable rootCause) Deprecated Since 2.7 Use variant that takes `JsonParser` instead
public	JsonMappingException(String msg, JsonLocation loc) Deprecated Since 2.7 Use variant that takes `JsonParser` instead
public	JsonMappingException(String msg, JsonLocation loc, Throwable rootCause) Deprecated Since 2.7 Use variant that takes `JsonParser` instead
public	JsonMappingException(Closeable processor, String msg)
public	JsonMappingException(Closeable processor, String msg, Throwable problem)
public	JsonMappingException(Closeable processor, String msg, JsonLocation loc)

Method Summary

Modifier and Type	Method and Description
protected void	_appendPathDesc(StringBuilder sb)
protected StringBuilder	_appendReferenceChain(StringBuilder sb) Method that is called to add reference chain information to message, but may be overridden to customize handling, including appending other information or removing the reference chain altogether.
protected String	_buildMessage()
private static JsonGenerator	_generator(SerializerProvider ctxt)
private static JsonParser	_parser(DeserializationContext ctxt)
public static JsonMappingException	from(JsonParser p, String msg)
public static JsonMappingException	from(JsonParser p, String msg, Throwable problem)
public static JsonMappingException	from(JsonGenerator g, String msg)
public static JsonMappingException	from(JsonGenerator g, String msg, Throwable problem)
public static JsonMappingException	from(DeserializationContext ctxt, String msg)
public static JsonMappingException	from(DeserializationContext ctxt, String msg, Throwable t)
public static JsonMappingException	from(SerializerProvider ctxt, String msg)
public static JsonMappingException	from(SerializerProvider ctxt, String msg, Throwable problem)
public static JsonMappingException	fromUnexpectedIOE(IOException src) Factory method used when "upgrading" an `IOException` into `JsonMappingException`: usually only needed to comply with a signature.
public String	getLocalizedMessage() Overrides java.lang.Throwable.getLocalizedMessage. Creates a localized description of this throwable.
public String	getMessage() Overrides com.fasterxml.jackson.core.JsonProcessingException.getMessage. Method is overridden so that we can properly inject description of problem path, if such is defined.
public List<JsonMappingException.Reference>	getPath() Method for accessing full structural path within type hierarchy down to problematic property.
public String	getPathReference() Method for accessing description of path that lead to the problem that triggered this exception
public StringBuilder	getPathReference(StringBuilder sb)
public Object	getProcessor() Overrides com.fasterxml.jackson.core.JsonProcessingException.getProcessor. Method that allows accessing underlying processor that triggered this exception; typically either `JsonParser` or `JsonGenerator` for exceptions that originate from streaming API.
public void	prependPath(Object referrer, String fieldName) Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath. Method called to prepend a reference information in front of current path
public void	prependPath(Object referrer, int index) Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath. Method called to prepend a reference information in front of current path
public void	prependPath(JsonMappingException.Reference r)
public String	toString() Overrides com.fasterxml.jackson.core.JsonProcessingException.toString. Returns a short description of this throwable.
public JsonMappingException	withCause(Throwable cause)
public static JsonMappingException	wrapWithPath(Throwable src, Object refFrom, String refFieldName) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), or augment given exception with given path/reference information.
public static JsonMappingException	wrapWithPath(Throwable src, Object refFrom, int index) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), or augment given exception with given path/reference information.
public static JsonMappingException	wrapWithPath(Throwable src, JsonMappingException.Reference ref) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), or augment given exception with given path/reference information.

Field Detail

_path	back to summary
protected LinkedList<JsonMappingException.Reference> _path Path through which problem that triggering throwing of this exception was reached.

_processor back to summary

_processor	back to summary
protected transient Closeable _processor Underlying processor (`JsonParser` or `JsonGenerator`), if known. Note typically not serializable hence `transient` Since 2.7

protected transient Closeable _processor

Underlying processor (JsonParser or JsonGenerator), if known.

Note

typically not serializable hence transient

Since: 2.7

MAX_REFS_TO_LIST	back to summary
pack-priv static final int MAX_REFS_TO_LIST Let's limit length of reference chain, to limit damage in cases of infinite recursion.

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.databind.DatabindException.serialVersionUID.

Constructor Detail

JsonMappingException	back to summary
public JsonMappingException(String msg) Deprecated Since 2.7 Use variant that takes `JsonParser` instead Annotations @Deprecated

JsonMappingException	back to summary
public JsonMappingException(String msg, Throwable rootCause) Deprecated Since 2.7 Use variant that takes `JsonParser` instead Annotations @Deprecated

JsonMappingException	back to summary
public JsonMappingException(String msg, JsonLocation loc) Deprecated Since 2.7 Use variant that takes `JsonParser` instead Annotations @Deprecated

JsonMappingException	back to summary
public JsonMappingException(String msg, JsonLocation loc, Throwable rootCause) Deprecated Since 2.7 Use variant that takes `JsonParser` instead Annotations @Deprecated

JsonMappingException	back to summary
public JsonMappingException(Closeable processor, String msg) Since 2.7

JsonMappingException	back to summary
public JsonMappingException(Closeable processor, String msg, Throwable problem) Since 2.7

JsonMappingException	back to summary
public JsonMappingException(Closeable processor, String msg, JsonLocation loc) Since 2.7

Method Detail

_appendPathDesc	back to summary
protected void _appendPathDesc(StringBuilder sb)

_appendReferenceChain	back to summary
protected StringBuilder _appendReferenceChain(StringBuilder sb) Method that is called to add reference chain information to message, but may be overridden to customize handling, including appending other information or removing the reference chain altogether. Since 2.18.2

_appendReferenceChain

back to summary

protected StringBuilder _appendReferenceChain(StringBuilder sb)

Method that is called to add reference chain information to message, but may be overridden to customize handling, including appending other information or removing the reference chain altogether.

Since: 2.18.2

_buildMessage	back to summary
protected String _buildMessage()

_generator	back to summary
private static JsonGenerator _generator(SerializerProvider ctxt)

_parser	back to summary
private static JsonParser _parser(DeserializationContext ctxt)

from	back to summary
public static JsonMappingException from(JsonParser p, String msg) Since 2.7

from	back to summary
public static JsonMappingException from(JsonParser p, String msg, Throwable problem) Since 2.7

from	back to summary
public static JsonMappingException from(JsonGenerator g, String msg) Since 2.7

from	back to summary
public static JsonMappingException from(JsonGenerator g, String msg, Throwable problem) Since 2.7

from	back to summary
public static JsonMappingException from(DeserializationContext ctxt, String msg) Since 2.7

from	back to summary
public static JsonMappingException from(DeserializationContext ctxt, String msg, Throwable t) Since 2.7

from	back to summary
public static JsonMappingException from(SerializerProvider ctxt, String msg) Since 2.7

from	back to summary
public static JsonMappingException from(SerializerProvider ctxt, String msg, Throwable problem) Since 2.7

fromUnexpectedIOE back to summary

fromUnexpectedIOE	back to summary
public static JsonMappingException fromUnexpectedIOE(IOException src) Factory method used when "upgrading" an `IOException` into `JsonMappingException`: usually only needed to comply with a signature. Note since 2.9 should usually NOT be used on input-side (deserialization) exceptions; instead use method(s) of `InputMismatchException` Since 2.1

public static JsonMappingException fromUnexpectedIOE(IOException src)

Factory method used when "upgrading" an IOException into JsonMappingException: usually only needed to comply with a signature.

Note

since 2.9 should usually NOT be used on input-side (deserialization) exceptions; instead use method(s) of InputMismatchException

Since: 2.1

getLocalizedMessage back to summary

getLocalizedMessage	back to summary
public String getLocalizedMessage() Overrides java.lang.Throwable.getLocalizedMessage. Doc from java.lang.Throwable.getLocalizedMessage. Creates a localized description of this throwable. Subclasses may override this method in order to produce a locale-specific message. For subclasses that do not override this method, the default implementation returns the same result as `getMessage()`. Returns:String The localized description of this throwable. Annotations @Override

public String getLocalizedMessage()

Overrides java.lang.Throwable.getLocalizedMessage.

Doc from java.lang.Throwable.getLocalizedMessage.

Creates a localized description of this throwable. Subclasses may override this method in order to produce a locale-specific message. For subclasses that do not override this method, the default implementation returns the same result as getMessage().

Returns:String

The localized description of this throwable.

Annotations

@Override

getMessage back to summary

getMessage	back to summary
public String getMessage() Overrides com.fasterxml.jackson.core.JsonProcessingException.getMessage. Method is overridden so that we can properly inject description of problem path, if such is defined. Returns:String Doc from com.fasterxml.jackson.core.JsonProcessingException.getMessage. Original `message` preceded by optional prefix and followed by location information, message and location information separated by a linefeed Annotations @Override

public String getMessage()

Overrides com.fasterxml.jackson.core.JsonProcessingException.getMessage.

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

Returns:String

Doc from com.fasterxml.jackson.core.JsonProcessingException.getMessage.

Original message preceded by optional prefix and followed by location information, message and location information separated by a linefeed

Annotations

@Override

getPath	back to summary
public List<JsonMappingException.Reference> getPath() Method for accessing full structural path within type hierarchy down to problematic property.

getPathReference	back to summary
public String getPathReference() Method for accessing description of path that lead to the problem that triggered this exception

getPathReference	back to summary
public StringBuilder getPathReference(StringBuilder sb)

getProcessor back to summary

getProcessor	back to summary
public Object getProcessor() Overrides com.fasterxml.jackson.core.JsonProcessingException.getProcessor. Doc from com.fasterxml.jackson.core.JsonProcessingException.getProcessor. Method that allows accessing underlying processor that triggered this exception; typically either `JsonParser` or `JsonGenerator` for exceptions that originate from streaming API. Note that it is possible that `null` may be returned if code throwing exception either has no access to 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. Returns:Object Originating processor, if available; null if not. Annotations @Override @JsonIgnore

public Object getProcessor()

Overrides com.fasterxml.jackson.core.JsonProcessingException.getProcessor.

Doc from com.fasterxml.jackson.core.JsonProcessingException.getProcessor.

Method that allows accessing underlying processor that triggered this exception; typically either JsonParser or JsonGenerator for exceptions that originate from streaming API. Note that it is possible that `null` may be returned if code throwing exception either has no access to 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.

Returns:Object

Originating processor, if available; null if not.

Annotations

@Override
@JsonIgnore

prependPath	back to summary
public void prependPath(Object referrer, String fieldName) Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath. Method called to prepend a reference information in front of current path Annotations @Override

prependPath

back to summary

public void prependPath(Object referrer, String fieldName)

Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath.

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

Annotations

@Override

prependPath	back to summary
public void prependPath(Object referrer, int index) Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath. Method called to prepend a reference information in front of current path Annotations @Override

prependPath

back to summary

public void prependPath(Object referrer, int index)

Implements abstract com.fasterxml.jackson.databind.DatabindException.prependPath.

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

Annotations

@Override

prependPath	back to summary
public void prependPath(JsonMappingException.Reference r)

toString back to summary

toString	back to summary
public String toString() Overrides com.fasterxml.jackson.core.JsonProcessingException.toString. Doc from java.lang.Throwable.toString. Returns a short description of this throwable. The result is the concatenation of: the name of the class of this object ": " (a colon and a space) the result of invoking this object's `getLocalizedMessage` method If `getLocalizedMessage` returns `null`, then just the class name is returned. Returns:String a string representation of this throwable. Annotations @Override

public String toString()

Overrides com.fasterxml.jackson.core.JsonProcessingException.toString.

Doc from java.lang.Throwable.toString.

Returns a short description of this throwable. The result is the concatenation of:

the name of the class of this object
": " (a colon and a space)
the result of invoking this object's getLocalizedMessage method

If getLocalizedMessage returns null, then just the class name is returned.

Returns:String

a string representation of this throwable.

Annotations

@Override

withCause	back to summary
public JsonMappingException withCause(Throwable cause) Since 2.13

wrapWithPath	back to summary
public static JsonMappingException wrapWithPath(Throwable src, Object refFrom, String refFieldName) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), 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

back to summary

public static JsonMappingException wrapWithPath(Throwable src, Object refFrom, String refFieldName)

Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), 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	back to summary
public static JsonMappingException wrapWithPath(Throwable src, Object refFrom, int index) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), 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

back to summary

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

wrapWithPath	back to summary
public static JsonMappingException wrapWithPath(Throwable src, JsonMappingException.Reference ref) Method that can be called to either create a new JsonMappingException (if underlying exception is not a JsonMappingException), or augment given exception with given path/reference information. Annotations @SuppressWarnings:resource

wrapWithPath

back to summary

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

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

Annotations

@SuppressWarnings:resource

com.fasterxml.jackson.databind back to summary

public Class JsonMappingException.Reference

Class Inheritance

extends Object
implements Serializable

java.lang.Object
com.fasterxml.jackson.databind.JsonMappingException.Reference

All Implemented Interfaces

java.io.Serializable

Simple bean class used to contain references. References can be added to indicate execution/reference path that lead to the problem that caused this exception to be thrown.

Field Summary

Modifier and Type	Field and Description
protected String	_desc Lazily-constructed description of this instance; needed mostly to allow JDK serialization to work in case where `_from` is non-serializable (and has to be dropped) but we still want to pass actual description along.
protected String	_fieldName Name of field (for beans) or key (for Maps) that is part of the reference.
protected transient Object	_from
protected int	_index Index within a `Collection` instance that contained the reference; used if index is relevant and available.
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
protected	Reference() Default constructor for deserialization/sub-classing purposes
public	Reference(Object from)
public	Reference(Object from, String fieldName)
public	Reference(Object from, int index)

Method Summary

Modifier and Type	Method and Description
public String	getDescription()
public String	getFieldName()
public Object	getFrom() Object through which reference was resolved.
public int	getIndex()
pack-priv void	setDescription(String d)
pack-priv void	setFieldName(String n)
pack-priv void	setIndex(int ix)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv Object	writeReplace() May need some cleaning here, given that `from` may or may not be serializable.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_desc back to summary

_desc	back to summary
protected String _desc Lazily-constructed description of this instance; needed mostly to allow JDK serialization to work in case where `_from` is non-serializable (and has to be dropped) but we still want to pass actual description along. Since 2.8

protected String _desc

Lazily-constructed description of this instance; needed mostly to allow JDK serialization to work in case where _from is non-serializable (and has to be dropped) but we still want to pass actual description along.

Since: 2.8

_fieldName	back to summary
protected String _fieldName Name of field (for beans) or key (for Maps) that is part of the reference. May be null for Collection types (which generally have `_index` defined), or when resolving Map classes without (yet) having an instance to operate on.

_from	back to summary
protected transient Object _from

_index	back to summary
protected int _index Index within a `Collection` instance that contained the reference; used if index is relevant and available. If either not applicable, or not available, -1 is used to denote "not known" (or not relevant).

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Reference	back to summary
protected Reference() Default constructor for deserialization/sub-classing purposes

Reference	back to summary
public Reference(Object from)

Reference	back to summary
public Reference(Object from, String fieldName)

Reference	back to summary
public Reference(Object from, int index)

Method Detail

getDescription	back to summary
public String getDescription()

getFieldName	back to summary
public String getFieldName()

getFrom

back to summary

public Object getFrom()

Object through which reference was resolved. Can be either actual instance (usually the case for serialization), or Class (usually the case for deserialization).

Note that this value must be `transient` to allow serializability (as often such Object is NOT serializable; or, in case of `Class`, may not available at the point of deserialization). As such will return `null` if instance has been passed using JDK serialization.

Annotations

@JsonIgnore

getIndex	back to summary
public int getIndex()

setDescription	back to summary
pack-priv void setDescription(String d)

setFieldName	back to summary
pack-priv void setFieldName(String n)

setIndex	back to summary
pack-priv void setIndex(int ix)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writeReplace	back to summary
pack-priv Object writeReplace() May need some cleaning here, given that `from` may or may not be serializable. since 2.8

public Class JsonMappingException

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class JsonMappingException.Reference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail