Module tools.jackson.core

Package tools.jackson.core.exc

Class StreamWriteException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

tools.jackson.core.JacksonException

tools.jackson.core.exc.StreamWriteException

All Implemented Interfaces:

Serializable

public class StreamWriteException
extends JacksonException

Intermediate base class for all write-side streaming processing problems, mostly content generation issues.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.core.JacksonException

JacksonException.Reference

Field Summary

Fields inherited from class tools.jackson.core.JacksonException

_location, _path, _processor

Constructor Summary

Constructors

Constructor	Description
StreamWriteException(JsonGenerator g, String msg)
StreamWriteException(JsonGenerator g, String msg, Throwable rootCause)
StreamWriteException(JsonGenerator g, Throwable rootCause)

Method Summary

Modifier and Type	Method	Description
JsonGenerator	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.
StreamWriteException	withGenerator(JsonGenerator g)	Fluent method that may be used to assign originating JsonGenerator, to be accessed using processor().

Methods inherited from class tools.jackson.core.JacksonException

_appendPathDesc, _appendReferenceChain, _buildMessage, _exceptionMessage, clearLocation, getLocalizedMessage, getLocation, getMessage, getOriginalMessage, getPath, getPathReference, getPathReference, messageSuffix, prependPath, prependPath, prependPath, toString, withCause, wrapWithPath, wrapWithPath, wrapWithPath, wrapWithPath

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

Constructor Details

StreamWriteException

public StreamWriteException(JsonGenerator g,
 Throwable rootCause)

StreamWriteException

public StreamWriteException(JsonGenerator g,
 String msg)

StreamWriteException

public StreamWriteException(JsonGenerator g,
 String msg,
 Throwable rootCause)

Method Details

withGenerator

public StreamWriteException withGenerator(JsonGenerator g)

Fluent method that may be used to assign originating JsonGenerator, to be accessed using processor().

Parameters:

g - Generator to assign

Returns:

This exception instance (to allow call chaining)

processor

public JsonGenerator processor()

Description copied from class: JacksonException

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.

Overrides:

processor in class JacksonException

Returns:

Originating processor, if available; null if not.