Package com.fasterxml.jackson.core
Class JsonProcessingException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.io.IOException
-
- com.fasterxml.jackson.core.JacksonException
-
- com.fasterxml.jackson.core.JsonProcessingException
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
JsonGenerationException
,StreamReadException
public class JsonProcessingException extends JacksonException
Intermediate base class for all problems encountered when processing (parsing, generating) JSON content that are not pure I/O problems. RegularIOException
s will be passed through as is. Sub-class ofIOException
for convenience.Since Jackson 2.12 extends intermediate
JacksonException
type instead of directly extendingIOException
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected JsonLocation
_location
-
Constructor Summary
Constructors Modifier Constructor Description protected
JsonProcessingException(java.lang.String msg)
protected
JsonProcessingException(java.lang.String msg, JsonLocation loc)
protected
JsonProcessingException(java.lang.String msg, JsonLocation loc, java.lang.Throwable rootCause)
protected
JsonProcessingException(java.lang.String msg, java.lang.Throwable rootCause)
protected
JsonProcessingException(java.lang.Throwable rootCause)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearLocation()
Method that allows to remove context information from this exception's message.JsonLocation
getLocation()
Accessor for location information related to position within input or output (depending on operation), if available; if not available may returnnull
.java.lang.String
getMessage()
Default implementation overridden so that we can add location informationprotected java.lang.String
getMessageSuffix()
Accessor that sub-classes can override to append additional information right after the main message, but before source location information.java.lang.String
getOriginalMessage()
Method that allows accessing the original "message" argument, without additional decorations (like location information) that overriddengetMessage()
adds.java.lang.Object
getProcessor()
Method that allows accessing underlying processor that triggered this exception; typically eitherJsonParser
orJsonGenerator
for exceptions that originate from streaming API.java.lang.String
toString()
-
-
-
Field Detail
-
_location
protected JsonLocation _location
-
-
Constructor Detail
-
JsonProcessingException
protected JsonProcessingException(java.lang.String msg, JsonLocation loc, java.lang.Throwable rootCause)
-
JsonProcessingException
protected JsonProcessingException(java.lang.String msg)
-
JsonProcessingException
protected JsonProcessingException(java.lang.String msg, JsonLocation loc)
-
JsonProcessingException
protected JsonProcessingException(java.lang.String msg, java.lang.Throwable rootCause)
-
JsonProcessingException
protected JsonProcessingException(java.lang.Throwable rootCause)
-
-
Method Detail
-
getLocation
public JsonLocation getLocation()
Description copied from class:JacksonException
Accessor for location information related to position within input or output (depending on operation), if available; if not available may returnnull
.Accuracy of location information depends on backend (format) as well as (in some cases) operation being performed.
- Specified by:
getLocation
in classJacksonException
- Returns:
- Location in input or output that triggered the problem reported, if
available;
null
otherwise.
-
clearLocation
public void 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.- Since:
- 2.9
-
getOriginalMessage
public java.lang.String getOriginalMessage()
Method that allows accessing the original "message" argument, without additional decorations (like location information) that overriddengetMessage()
adds.- Specified by:
getOriginalMessage
in classJacksonException
- Returns:
- Original message passed in constructor
- Since:
- 2.1
-
getProcessor
public java.lang.Object getProcessor()
Method that allows accessing underlying processor that triggered this exception; typically eitherJsonParser
orJsonGenerator
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.- Specified by:
getProcessor
in classJacksonException
- Returns:
- Originating processor, if available; null if not.
- Since:
- 2.7
-
getMessageSuffix
protected java.lang.String getMessageSuffix()
Accessor that sub-classes can override to append additional information right after the main message, but before source location information.- Returns:
- Message suffix assigned, if any;
null
if none
-
getMessage
public java.lang.String getMessage()
Default implementation overridden so that we can add location information- Overrides:
getMessage
in classjava.lang.Throwable
- Returns:
- Original
message
preceded by optional prefix and followed by location information, message and location information separated by a linefeed
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Throwable
-
-