Module tools.jackson.dataformat.xml

Package tools.jackson.dataformat.xml

Class XmlFactoryBuilder

java.lang.Object

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

tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder<XmlFactory,XmlFactoryBuilder>

tools.jackson.dataformat.xml.XmlFactoryBuilder

public class XmlFactoryBuilder
extends tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder<XmlFactory,XmlFactoryBuilder>

TSFBuilder implementation for constructing XmlFactory instances.

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassLoader	_classLoaderForStax	Optional ClassLoader to use for constructing XMLInputFactory and XMLOutputFactory instances if not explicitly specified by caller.
protected String	_nameForTextElement	In cases where a start element has both attributes and non-empty textual value, we have to create a bogus property; we will use this as the property name.
protected XmlNameProcessor	_nameProcessor	See XmlNameProcessor and XmlNameProcessors
protected XMLInputFactory	_xmlInputFactory	Stax factory for creating underlying input stream readers; `null` for "use default instance with default settings"
protected XMLOutputFactory	_xmlOutputFactory	Stax factory for creating underlying output stream writers; `null` for "use default instance with default settings"

Fields inherited from class tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder

_generatorDecorators, _inputDecorator, _outputDecorator

Fields inherited from class tools.jackson.core.TSFBuilder

_errorReportConfiguration, _factoryFeatures, _formatReadFeatures, _formatWriteFeatures, _recyclerPool, _streamReadConstraints, _streamReadFeatures, _streamWriteConstraints, _streamWriteFeatures

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlFactoryBuilder()
	XmlFactoryBuilder(XmlFactory base)

Method Summary

Modifier and Type	Method	Description
XmlFactory	build()
XmlFactoryBuilder	configure(XmlReadFeature f, boolean state)
XmlFactoryBuilder	configure(XmlWriteFeature f, boolean state)
XmlFactoryBuilder	configureForJackson2()	Overridden to also disable the XML format features whose defaults changed from Jackson 2.x to 3.x; needs to be kept in sync with XmlMapper.Builder#configureForJackson2().
protected XMLInputFactory	defaultXmlInputFactory()
protected static XMLInputFactory	defaultXmlInputFactory(ClassLoader cl)
protected XMLOutputFactory	defaultXmlOutputFactory()
protected static XMLOutputFactory	defaultXmlOutputFactory(ClassLoader cl)
XmlFactoryBuilder	disable(XmlReadFeature f)
XmlFactoryBuilder	disable(XmlReadFeature first, XmlReadFeature... other)
XmlFactoryBuilder	disable(XmlWriteFeature f)
XmlFactoryBuilder	disable(XmlWriteFeature first, XmlWriteFeature... other)
XmlFactoryBuilder	enable(XmlReadFeature f)
XmlFactoryBuilder	enable(XmlReadFeature first, XmlReadFeature... other)
XmlFactoryBuilder	enable(XmlWriteFeature f)
XmlFactoryBuilder	enable(XmlWriteFeature first, XmlWriteFeature... other)
String	nameForTextElement()
XmlFactoryBuilder	nameForTextElement(String name)
protected ClassLoader	staxClassLoader()
XmlFactoryBuilder	staxClassLoader(ClassLoader cl)	Method that can be used to specific ClassLoader for creating XMLInputFactory and XMLOutputFactory instances if those are not explicitly defined by caller: passed to respective newFactory() methods.
XMLInputFactory	xmlInputFactory()
XmlFactoryBuilder	xmlInputFactory(XMLInputFactory xmlIn)
XmlNameProcessor	xmlNameProcessor()
XmlFactoryBuilder	xmlNameProcessor(XmlNameProcessor nameProcessor)
XMLOutputFactory	xmlOutputFactory()
XmlFactoryBuilder	xmlOutputFactory(XMLOutputFactory xmlOut)

Methods inherited from class tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder

addDecorator, generatorDecorators, inputDecorator, inputDecorator, outputDecorator, outputDecorator

Methods inherited from class tools.jackson.core.TSFBuilder

_this, configure, configure, configure, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, errorReportConfiguration, factoryFeaturesMask, formatReadFeaturesMask, formatWriteFeaturesMask, recyclerPool, recyclerPool, streamReadConstraints, streamReadFeaturesMask, streamWriteConstraints, streamWriteFeaturesMask

Methods inherited from class java.lang.Object

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

Field Details

_xmlInputFactory

protected XMLInputFactory _xmlInputFactory

Stax factory for creating underlying input stream readers; `null` for "use default instance with default settings"

_xmlOutputFactory

protected XMLOutputFactory _xmlOutputFactory

Stax factory for creating underlying output stream writers; `null` for "use default instance with default settings"

_nameForTextElement

protected String _nameForTextElement

In cases where a start element has both attributes and non-empty textual value, we have to create a bogus property; we will use this as the property name.

Name used for pseudo-property used for returning XML Text value (which does not have actual element name to use). Defaults to empty String, but may be changed for inter-operability reasons: JAXB, for example, uses "value" as name.

_classLoaderForStax

protected ClassLoader _classLoaderForStax

Optional ClassLoader to use for constructing XMLInputFactory and XMLOutputFactory instances if not explicitly specified by caller. If not specified, will default to ClassLoader that loaded this class.

_nameProcessor

protected XmlNameProcessor _nameProcessor

See XmlNameProcessor and XmlNameProcessors

Constructor Details

XmlFactoryBuilder

protected XmlFactoryBuilder()

XmlFactoryBuilder

public XmlFactoryBuilder(XmlFactory base)

Method Details

nameForTextElement

public String nameForTextElement()

xmlInputFactory

public XMLInputFactory xmlInputFactory()

defaultXmlInputFactory

protected XMLInputFactory defaultXmlInputFactory()

defaultXmlInputFactory

protected static XMLInputFactory defaultXmlInputFactory(ClassLoader cl)

xmlOutputFactory

public XMLOutputFactory xmlOutputFactory()

defaultXmlOutputFactory

protected XMLOutputFactory defaultXmlOutputFactory()

defaultXmlOutputFactory

protected static XMLOutputFactory defaultXmlOutputFactory(ClassLoader cl)

staxClassLoader

protected ClassLoader staxClassLoader()

xmlNameProcessor

public XmlNameProcessor xmlNameProcessor()

enable

public XmlFactoryBuilder enable(XmlReadFeature f)

enable

public XmlFactoryBuilder enable(XmlReadFeature first,
 XmlReadFeature... other)

disable

public XmlFactoryBuilder disable(XmlReadFeature f)

disable

public XmlFactoryBuilder disable(XmlReadFeature first,
 XmlReadFeature... other)

configure

public XmlFactoryBuilder configure(XmlReadFeature f,
 boolean state)

enable

public XmlFactoryBuilder enable(XmlWriteFeature f)

enable

public XmlFactoryBuilder enable(XmlWriteFeature first,
 XmlWriteFeature... other)

disable

public XmlFactoryBuilder disable(XmlWriteFeature f)

disable

public XmlFactoryBuilder disable(XmlWriteFeature first,
 XmlWriteFeature... other)

configure

public XmlFactoryBuilder configure(XmlWriteFeature f,
 boolean state)

configureForJackson2

public XmlFactoryBuilder configureForJackson2()

Overridden to also disable the XML format features whose defaults changed from Jackson 2.x to 3.x; needs to be kept in sync with XmlMapper.Builder#configureForJackson2().

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

Overrides:

configureForJackson2 in class tools.jackson.core.TSFBuilder<XmlFactory,XmlFactoryBuilder>

nameForTextElement

public XmlFactoryBuilder nameForTextElement(String name)

xmlInputFactory

public XmlFactoryBuilder xmlInputFactory(XMLInputFactory xmlIn)

xmlOutputFactory

public XmlFactoryBuilder xmlOutputFactory(XMLOutputFactory xmlOut)

staxClassLoader

public XmlFactoryBuilder staxClassLoader(ClassLoader cl)

Method that can be used to specific ClassLoader for creating XMLInputFactory and XMLOutputFactory instances if those are not explicitly defined by caller: passed to respective newFactory() methods.
NOTE: recommended approach is to explicitly pass XMLInputFactory and XMLOutputFactory methods instead of relying on JDK SPI mechanism.

xmlNameProcessor

public XmlFactoryBuilder xmlNameProcessor(XmlNameProcessor nameProcessor)

build

public XmlFactory build()

Specified by:

build in class tools.jackson.core.TSFBuilder<XmlFactory,XmlFactoryBuilder>