Module tools.jackson.core

Package tools.jackson.core.base

Class DecorableTSFactory

java.lang.Object

tools.jackson.core.TokenStreamFactory

tools.jackson.core.base.DecorableTSFactory

All Implemented Interfaces:

Serializable, Snapshottable<TokenStreamFactory>, Versioned

Direct Known Subclasses:

BinaryTSFactory, TextualTSFactory

public abstract class DecorableTSFactory
extends TokenStreamFactory
implements Serializable

Intermediate base TokenStreamFactory implementation that offers support for streams that allow decoration of low-level input sources and output targets.

Since:

3.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DecorableTSFactory.DecorableTSFBuilder<F extends TokenStreamFactory,T extends TSFBuilder<F,T>>	Since factory instances are immutable, a Builder class is needed for creating configurations for differently configured factory instances.

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

TokenStreamFactory.Feature

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JsonGeneratorDecorator>	_generatorDecorators
protected final InputDecorator	_inputDecorator	Optional helper object that may decorate input sources, to do additional processing on input during parsing.
protected final OutputDecorator	_outputDecorator	Optional helper object that may decorate output object, to do additional processing on output during content generation.

Fields inherited from class tools.jackson.core.TokenStreamFactory

_errorReportConfiguration, _factoryFeatures, _formatReadFeatures, _formatWriteFeatures, _recyclerPool, _streamReadConstraints, _streamReadFeatures, _streamWriteConstraints, _streamWriteFeatures, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_STREAM_READ_FEATURE_FLAGS, DEFAULT_STREAM_WRITE_FEATURE_FLAGS, EMPTY_WRITE_CONTEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecorableTSFactory(DecorableTSFactory src)
protected	DecorableTSFactory(DecorableTSFactory.DecorableTSFBuilder<?,?> baseBuilder)	Constructor used by builders for instantiation.
protected	DecorableTSFactory(StreamReadConstraints src, StreamWriteConstraints swc, ErrorReportConfiguration erc, int formatPF, int formatGF)

Method Summary

Modifier and Type	Method	Description
protected static void	_closeOnFailedConstruction(Closeable toClose, Closeable rawFallback, RuntimeException failure)	Variant of _closeOnFailedConstruction(Closeable, RuntimeException) for case where the resource to close may wrap (decorate) the source/target Jackson opened: closing the outermost resource is expected to close what it wraps, so underlying resource is only closed if closing of the outermost one failed.
protected static void	_closeOnFailedConstruction(Closeable toClose, RuntimeException failure)	Method called when construction of parser or generator fails after Jackson has opened source or target itself (from File or Path): closes it so that it does not get leaked.
protected static <T> List<T>	_copy(List<T> src)
protected DataInput	_decorate(IOContext ioCtxt, DataInput in)
protected InputStream	_decorate(IOContext ioCtxt, InputStream in)
protected OutputStream	_decorate(IOContext ioCtxt, OutputStream out)
protected Reader	_decorate(IOContext ioCtxt, Reader in)
protected Writer	_decorate(IOContext ioCtxt, Writer out)
protected JsonGenerator	_decorate(JsonGenerator result)
protected static void	_releaseOnFailedConstruction(IOContext ioCtxt, RuntimeException failure)	Method called when construction of parser or generator fails: releases IOContext so that BufferRecycler it leased gets returned to the pool.
List<JsonGeneratorDecorator>	getGeneratorDecorators()
InputDecorator	getInputDecorator()
OutputDecorator	getOutputDecorator()

Methods inherited from class tools.jackson.core.TokenStreamFactory

_checkRangeBoundsForByteArray, _checkRangeBoundsForCharArray, _createContentReference, _createContentReference, _createContext, _createContext, _createDataOutputWrapper, _fileInputStream, _fileOutputStream, _getBufferRecycler, _getRecyclerPool, _optimizedStreamFromURL, _pathInputStream, _pathOutputStream, _reportRangeError, _unsupported, _unsupported, _wrapIOFailure, canHandleBinaryNatively, canParseAsync, canUseSchema, constructCINameMatcher, constructNameMatcher, copy, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createNonBlockingByteBufferParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, errorReportConfiguration, getFactoryFeatures, getFormatName, getFormatReadFeatures, getFormatReadFeatureType, getFormatWriteFeatures, getFormatWriteFeatureType, getStreamReadFeatures, getStreamWriteFeatures, isEnabled, isEnabled, isEnabled, rebuild, requiresPropertyOrdering, snapshot, streamReadConstraints, streamWriteConstraints, version

Methods inherited from class java.lang.Object

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

Field Details

_inputDecorator

protected final InputDecorator _inputDecorator

Optional helper object that may decorate input sources, to do additional processing on input during parsing.

_outputDecorator

protected final OutputDecorator _outputDecorator

Optional helper object that may decorate output object, to do additional processing on output during content generation.

_generatorDecorators

protected List<JsonGeneratorDecorator> _generatorDecorators

Constructor Details

DecorableTSFactory

protected DecorableTSFactory(StreamReadConstraints src,
 StreamWriteConstraints swc,
 ErrorReportConfiguration erc,
 int formatPF,
 int formatGF)

DecorableTSFactory

protected DecorableTSFactory(DecorableTSFactory.DecorableTSFBuilder<?,?> baseBuilder)

Constructor used by builders for instantiation.

Parameters:

baseBuilder - Builder with configurations to use

Since:

3.0

DecorableTSFactory

protected DecorableTSFactory(DecorableTSFactory src)

Method Details

_copy

protected static <T> List<T> _copy(List<T> src)

getOutputDecorator

public OutputDecorator getOutputDecorator()

getInputDecorator

public InputDecorator getInputDecorator()

getGeneratorDecorators

public List<JsonGeneratorDecorator> getGeneratorDecorators()

_decorate

protected InputStream _decorate(IOContext ioCtxt,
 InputStream in)
                         throws JacksonException

Throws:

JacksonException

_decorate

protected Reader _decorate(IOContext ioCtxt,
 Reader in)
                    throws JacksonException

Throws:

JacksonException

_decorate

protected DataInput _decorate(IOContext ioCtxt,
 DataInput in)
                       throws JacksonException

Throws:

JacksonException

_decorate

protected OutputStream _decorate(IOContext ioCtxt,
 OutputStream out)
                          throws JacksonException

Throws:

JacksonException

_decorate

protected Writer _decorate(IOContext ioCtxt,
 Writer out)
                    throws JacksonException

Throws:

JacksonException

_decorate

protected JsonGenerator _decorate(JsonGenerator result)

_releaseOnFailedConstruction

protected static void _releaseOnFailedConstruction(IOContext ioCtxt,
 RuntimeException failure)

Method called when construction of parser or generator fails: releases IOContext so that BufferRecycler it leased gets returned to the pool. Without this the lease is simply dropped, since context is otherwise only released when parser or generator that owns it gets closed.

Parameters:

ioCtxt - Context to release, if any (null if not yet created)

failure - Failure to add possible secondary failure to, as suppressed

Since:

3.1.7

_closeOnFailedConstruction

protected static void _closeOnFailedConstruction(Closeable toClose,
 RuntimeException failure)

Method called when construction of parser or generator fails after Jackson has opened source or target itself (from File or Path): closes it so that it does not get leaked. Caller-provided sources and targets are never passed here.

Parameters:

toClose - Source/target Jackson opened, if any (null if not yet opened)

failure - Failure to add possible secondary failure to, as suppressed

Since:

3.1.7

_closeOnFailedConstruction

protected static void _closeOnFailedConstruction(Closeable toClose,
 Closeable rawFallback,
 RuntimeException failure)

Variant of _closeOnFailedConstruction(Closeable, RuntimeException) for case where the resource to close may wrap (decorate) the source/target Jackson opened: closing the outermost resource is expected to close what it wraps, so underlying resource is only closed if closing of the outermost one failed.

Parameters:

toClose - Outermost source/target to close, if any (null if not yet opened)

rawFallback - Source/target Jackson opened: closed if, and only if, closing of toClose failed

failure - Failure to add possible secondary failure to, as suppressed

Since:

3.1.7