Module tools.jackson.core

Package tools.jackson.core

Class TSFBuilder<F extends TokenStreamFactory,B extends TSFBuilder<F,B>>

java.lang.Object

tools.jackson.core.TSFBuilder<F,B>

Direct Known Subclasses:

DecorableTSFactory.DecorableTSFBuilder

public abstract class TSFBuilder<F extends TokenStreamFactory,B extends TSFBuilder<F,B>>
extends Object

Since factory instances are immutable, a Builder class is needed for creating configurations for differently configured factory instances.

Field Summary

Fields

Modifier and Type	Field	Description
protected ErrorReportConfiguration	_errorReportConfiguration	ErrorReportConfiguration to use.
protected int	_factoryFeatures	Set of TokenStreamFactory.Features enabled, as bitmask.
protected int	_formatReadFeatures	Set of format-specific read FormatFeatures enabled, as bitmask.
protected int	_formatWriteFeatures	Set of format-specific write FormatFeatures enabled, as bitmask.
protected RecyclerPool<BufferRecycler>	_recyclerPool	Buffer recycler provider to use.
protected StreamReadConstraints	_streamReadConstraints	StreamReadConstraints to use.
protected int	_streamReadFeatures	Set of StreamReadFeatures enabled, as bitmask.
protected StreamWriteConstraints	_streamWriteConstraints	StreamWriteConstraints to use.
protected int	_streamWriteFeatures	Set of StreamWriteFeatures enabled, as bitmask.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TSFBuilder(StreamReadConstraints src, StreamWriteConstraints swc, ErrorReportConfiguration erc, int formatReadF, int formatWriteF)
protected	TSFBuilder(TokenStreamFactory base)
protected	TSFBuilder(RecyclerPool<BufferRecycler> brp, StreamReadConstraints src, StreamWriteConstraints swc, ErrorReportConfiguration erc, int factoryFeatures, int streamReadFeatures, int streamWriteFeatures, int formatReadFeatures, int formatWriteFeatures)

Method Summary

Modifier and Type	Method	Description
protected final B	_this()
abstract F	build()	Method for constructing actual TokenStreamFactory instance, given configuration.
B	configure(StreamReadFeature f, boolean state)
B	configure(StreamWriteFeature f, boolean state)
B	configure(TokenStreamFactory.Feature f, boolean state)
B	configureForJackson2()	The builder returned uses default settings more closely matching the default configs used in Jackson 2.x versions.
B	disable(StreamReadFeature f)
B	disable(StreamReadFeature first, StreamReadFeature... other)
B	disable(StreamWriteFeature f)
B	disable(StreamWriteFeature first, StreamWriteFeature... other)
B	disable(TokenStreamFactory.Feature f)
B	enable(StreamReadFeature f)
B	enable(StreamReadFeature first, StreamReadFeature... other)
B	enable(StreamWriteFeature f)
B	enable(StreamWriteFeature first, StreamWriteFeature... other)
B	enable(TokenStreamFactory.Feature f)
B	errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)	Sets the configuration for error tokens.
int	factoryFeaturesMask()
int	formatReadFeaturesMask()
int	formatWriteFeaturesMask()
RecyclerPool<BufferRecycler>	recyclerPool()
B	recyclerPool(RecyclerPool<BufferRecycler> p)
B	streamReadConstraints(StreamReadConstraints streamReadConstraints)	Sets the constraints for streaming reads.
int	streamReadFeaturesMask()
B	streamWriteConstraints(StreamWriteConstraints streamWriteConstraints)	Sets the constraints for streaming writes.
int	streamWriteFeaturesMask()

Methods inherited from class java.lang.Object

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

Field Details

_factoryFeatures

protected int _factoryFeatures

Set of TokenStreamFactory.Features enabled, as bitmask.

_streamReadFeatures

protected int _streamReadFeatures

Set of StreamReadFeatures enabled, as bitmask.

_streamWriteFeatures

protected int _streamWriteFeatures

Set of StreamWriteFeatures enabled, as bitmask.

_formatReadFeatures

protected int _formatReadFeatures

Set of format-specific read FormatFeatures enabled, as bitmask.

_formatWriteFeatures

protected int _formatWriteFeatures

Set of format-specific write FormatFeatures enabled, as bitmask.

_recyclerPool

protected RecyclerPool<BufferRecycler> _recyclerPool

Buffer recycler provider to use.

_streamReadConstraints

protected StreamReadConstraints _streamReadConstraints

StreamReadConstraints to use.

_streamWriteConstraints

protected StreamWriteConstraints _streamWriteConstraints

StreamWriteConstraints to use.

_errorReportConfiguration

protected ErrorReportConfiguration _errorReportConfiguration

ErrorReportConfiguration to use.

Constructor Details

TSFBuilder

protected TSFBuilder(StreamReadConstraints src,
 StreamWriteConstraints swc,
 ErrorReportConfiguration erc,
 int formatReadF,
 int formatWriteF)

TSFBuilder

protected TSFBuilder(TokenStreamFactory base)

TSFBuilder

protected TSFBuilder(RecyclerPool<BufferRecycler> brp,
 StreamReadConstraints src,
 StreamWriteConstraints swc,
 ErrorReportConfiguration erc,
 int factoryFeatures,
 int streamReadFeatures,
 int streamWriteFeatures,
 int formatReadFeatures,
 int formatWriteFeatures)

Method Details

factoryFeaturesMask

public int factoryFeaturesMask()

streamReadFeaturesMask

public int streamReadFeaturesMask()

streamWriteFeaturesMask

public int streamWriteFeaturesMask()

formatReadFeaturesMask

public int formatReadFeaturesMask()

formatWriteFeaturesMask

public int formatWriteFeaturesMask()

recyclerPool

public RecyclerPool<BufferRecycler> recyclerPool()

enable

public B enable(TokenStreamFactory.Feature f)

disable

public B disable(TokenStreamFactory.Feature f)

configure

public B configure(TokenStreamFactory.Feature f,
 boolean state)

enable

public B enable(StreamReadFeature f)

enable

public B enable(StreamReadFeature first,
 StreamReadFeature... other)

disable

public B disable(StreamReadFeature f)

disable

public B disable(StreamReadFeature first,
 StreamReadFeature... other)

configure

public B configure(StreamReadFeature f,
 boolean state)

enable

public B enable(StreamWriteFeature f)

enable

public B enable(StreamWriteFeature first,
 StreamWriteFeature... other)

disable

public B disable(StreamWriteFeature f)

disable

public B disable(StreamWriteFeature first,
 StreamWriteFeature... other)

configure

public B configure(StreamWriteFeature f,
 boolean state)

configureForJackson2

public B configureForJackson2()

The builder returned uses default settings more closely matching the default configs used in Jackson 2.x versions.

This method is still a work in progress and may not yet fully replicate the default settings of Jackson 2.x.

streamReadConstraints

public B streamReadConstraints(StreamReadConstraints streamReadConstraints)

Sets the constraints for streaming reads.

Parameters:

streamReadConstraints - constraints for streaming reads

Returns:

this builder

streamWriteConstraints

public B streamWriteConstraints(StreamWriteConstraints streamWriteConstraints)

Sets the constraints for streaming writes.

Parameters:

streamWriteConstraints - constraints for streaming writes

Returns:

this builder

errorReportConfiguration

public B errorReportConfiguration(ErrorReportConfiguration errorReportConfiguration)

Sets the configuration for error tokens.

Parameters:

errorReportConfiguration - configuration values used for handling errorneous token inputs.

Returns:

this builder

recyclerPool

public B recyclerPool(RecyclerPool<BufferRecycler> p)

Parameters:

p - RecyclerPool to use for buffer allocation

Returns:

this builder (for call chaining)

build

public abstract F build()

Method for constructing actual TokenStreamFactory instance, given configuration.

Returns:

TokenStreamFactory build using builder configuration settings

_this

protected final B _this()