com.fasterxml.jackson.dataformat.xml

Class XmlFactoryBuilder

java.lang.Object

com.fasterxml.jackson.core.TSFBuilder<XmlFactory,XmlFactoryBuilder>

com.fasterxml.jackson.dataformat.xml.XmlFactoryBuilder

public class XmlFactoryBuilder
extends com.fasterxml.jackson.core.TSFBuilder<XmlFactory,XmlFactoryBuilder>

TSFBuilder implementation for constructing XmlFactory instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	_classLoaderForStax Optional ClassLoader to use for constructing XMLInputFactory and instances if not explicitly specified by caller.
protected int	_formatGeneratorFeatures Set of s enabled, as bitmask.
protected int	_formatParserFeatures Set of FromXmlParser.Features enabled, as bitmask.
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 com.fasterxml.jackson.core.TSFBuilder

_factoryFeatures, _inputDecorator, _outputDecorator, _streamReadFeatures, _streamWriteFeatures, DEFAULT_FACTORY_FEATURE_FLAGS, DEFAULT_GENERATOR_FEATURE_FLAGS, DEFAULT_PARSER_FEATURE_FLAGS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
XmlFactory	build()
XmlFactoryBuilder	configure(FromXmlParser.Feature f, boolean state)
XmlFactoryBuilder	configure(ToXmlGenerator.Feature f, boolean state)
protected XMLInputFactory	defaultInputFactory()
protected XMLOutputFactory	defaultOutputFactory()
XmlFactoryBuilder	disable(FromXmlParser.Feature f)
XmlFactoryBuilder	disable(FromXmlParser.Feature first, FromXmlParser.Feature... other)
XmlFactoryBuilder	disable(ToXmlGenerator.Feature f)
XmlFactoryBuilder	disable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)
XmlFactoryBuilder	enable(FromXmlParser.Feature f)
XmlFactoryBuilder	enable(FromXmlParser.Feature first, FromXmlParser.Feature... other)
XmlFactoryBuilder	enable(ToXmlGenerator.Feature f)
XmlFactoryBuilder	enable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)
int	formatGeneratorFeaturesMask()
int	formatParserFeaturesMask()
XmlFactoryBuilder	inputFactory(XMLInputFactory xmlIn) Deprecated. Since 2.13 use xmlInputFactory() instead
String	nameForTextElement()
XmlFactoryBuilder	nameForTextElement(String name)
XmlFactoryBuilder	outputFactory(XMLOutputFactory xmlOut) Deprecated. Since 2.13 use xmlOutputFactory() instead
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 com.fasterxml.jackson.core.TSFBuilder

_legacyDisable, _legacyDisable, _legacyEnable, _legacyEnable, _this, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, enable, enable, enable, factoryFeaturesMask, inputDecorator, inputDecorator, outputDecorator, outputDecorator, streamReadFeatures, streamWriteFeatures

Methods inherited from class java.lang.Object

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

Field Detail

_formatParserFeatures

protected int _formatParserFeatures

Set of FromXmlParser.Features enabled, as bitmask.

_formatGeneratorFeatures

protected int _formatGeneratorFeatures

Set of s enabled, as bitmask.

_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 interoperability reasons: JAXB, for example, uses "value" as name.

_classLoaderForStax

protected ClassLoader _classLoaderForStax

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

Since:

2.13

_nameProcessor

protected XmlNameProcessor _nameProcessor

See XmlNameProcessor and XmlNameProcessors

Since:

2.14

Constructor Detail

XmlFactoryBuilder

protected XmlFactoryBuilder()

XmlFactoryBuilder

public XmlFactoryBuilder(XmlFactory base)

Method Detail

formatParserFeaturesMask

public int formatParserFeaturesMask()

formatGeneratorFeaturesMask

public int formatGeneratorFeaturesMask()

nameForTextElement

public String nameForTextElement()

xmlInputFactory

public XMLInputFactory xmlInputFactory()

defaultInputFactory

protected XMLInputFactory defaultInputFactory()

xmlOutputFactory

public XMLOutputFactory xmlOutputFactory()

defaultOutputFactory

protected XMLOutputFactory defaultOutputFactory()

staxClassLoader

protected ClassLoader staxClassLoader()

xmlNameProcessor

public XmlNameProcessor xmlNameProcessor()

enable

public XmlFactoryBuilder enable(FromXmlParser.Feature f)

enable

public XmlFactoryBuilder enable(FromXmlParser.Feature first,
                                FromXmlParser.Feature... other)

disable

public XmlFactoryBuilder disable(FromXmlParser.Feature f)

disable

public XmlFactoryBuilder disable(FromXmlParser.Feature first,
                                 FromXmlParser.Feature... other)

configure

public XmlFactoryBuilder configure(FromXmlParser.Feature f,
                                   boolean state)

enable

public XmlFactoryBuilder enable(ToXmlGenerator.Feature f)

enable

public XmlFactoryBuilder enable(ToXmlGenerator.Feature first,
                                ToXmlGenerator.Feature... other)

disable

public XmlFactoryBuilder disable(ToXmlGenerator.Feature f)

disable

public XmlFactoryBuilder disable(ToXmlGenerator.Feature first,
                                 ToXmlGenerator.Feature... other)

configure

public XmlFactoryBuilder configure(ToXmlGenerator.Feature f,
                                   boolean state)

nameForTextElement

public XmlFactoryBuilder nameForTextElement(String name)

xmlInputFactory

public XmlFactoryBuilder xmlInputFactory(XMLInputFactory xmlIn)

Since:

2.13 (was misnamed as inputFactory(in) formerly)

xmlOutputFactory

public XmlFactoryBuilder xmlOutputFactory(XMLOutputFactory xmlOut)

Since:

2.13 (was misnamed as outputFactory(in) formerly)

inputFactory

@Deprecated
public XmlFactoryBuilder inputFactory(XMLInputFactory xmlIn)

Deprecated. Since 2.13 use xmlInputFactory() instead

outputFactory

@Deprecated
public XmlFactoryBuilder outputFactory(XMLOutputFactory xmlOut)

Deprecated. Since 2.13 use xmlOutputFactory() instead

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.

Since:

2.13

xmlNameProcessor

public XmlFactoryBuilder xmlNameProcessor(XmlNameProcessor nameProcessor)

Since:

2.14

build

public XmlFactory build()

Specified by:

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