Jackson-dataformat-XML 2.16.1 · com.fasterxml.jackson.dataformat.xml.XmlFactoryBuilder

Field Summary

Modifier and Type	Field and Description
protected ClassLoader	_classLoaderForStax Optional `ClassLoader` to use for constructing `XMLInputFactory` and {@kink XMLOutputFactory} instances if not explicitly specified by caller.
protected int	_formatGeneratorFeatures Set of {@@ code ToXmlGenerator.Feature}s enabled, as bitmask.
protected int	_formatParserFeatures Set of `FromXmlParser.Feature`s 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"

Inherited from com.fasterxml.jackson.core.TSFBuilder:: _errorReportConfiguration _factoryFeatures _generatorDecorators _inputDecorator _outputDecorator _recyclerPool _streamReadConstraints _streamReadFeatures _streamWriteConstraints _streamWriteFeatures DEFAULT_FACTORY_FEATURE_FLAGS DEFAULT_GENERATOR_FEATURE_FLAGS DEFAULT_PARSER_FEATURE_FLAGS

Constructor Summary

Access	Constructor and Description
protected	XmlFactoryBuilder()
public	XmlFactoryBuilder(XmlFactory base)

Method Summary

Modifier and Type	Method and Description
public XmlFactory	build() Implements abstract com.fasterxml.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration.
public XmlFactoryBuilder	configure(FromXmlParser.Feature f, boolean state)
public XmlFactoryBuilder	configure(ToXmlGenerator.Feature f, boolean state)
protected XMLInputFactory	defaultInputFactory()
protected XMLOutputFactory	defaultOutputFactory()
public XmlFactoryBuilder	disable(FromXmlParser.Feature f)
public XmlFactoryBuilder	disable(FromXmlParser.Feature first, FromXmlParser.Feature... other)
public XmlFactoryBuilder	disable(ToXmlGenerator.Feature f)
public XmlFactoryBuilder	disable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)
public XmlFactoryBuilder	enable(FromXmlParser.Feature f)
public XmlFactoryBuilder	enable(FromXmlParser.Feature first, FromXmlParser.Feature... other)
public XmlFactoryBuilder	enable(ToXmlGenerator.Feature f)
public XmlFactoryBuilder	enable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)
public int	formatGeneratorFeaturesMask()
public int	formatParserFeaturesMask()
public XmlFactoryBuilder	inputFactory(XMLInputFactory xmlIn) Deprecated Since 2.13 use `xmlInputFactory()` instead
public String	nameForTextElement()
public XmlFactoryBuilder	nameForTextElement(String name)
public XmlFactoryBuilder	outputFactory(XMLOutputFactory xmlOut) Deprecated Since 2.13 use `xmlOutputFactory()` instead
protected ClassLoader	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.
public XMLInputFactory	xmlInputFactory()
public XmlFactoryBuilder	xmlInputFactory(XMLInputFactory xmlIn)
public XmlNameProcessor	xmlNameProcessor()
public XmlFactoryBuilder	xmlNameProcessor(XmlNameProcessor nameProcessor)
public XMLOutputFactory	xmlOutputFactory()
public XmlFactoryBuilder	xmlOutputFactory(XMLOutputFactory xmlOut)

Field Detail

_classLoaderForStax back to summary

_classLoaderForStax	back to summary
protected ClassLoader _classLoaderForStax Optional `ClassLoader` to use for constructing `XMLInputFactory` and {@kink XMLOutputFactory} instances if not explicitly specified by caller. If not specified, will default to `ClassLoader` that loaded this class. Since 2.13

protected ClassLoader _classLoaderForStax

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

Since: 2.13

_formatGeneratorFeatures	back to summary
protected int _formatGeneratorFeatures Set of {@@ code ToXmlGenerator.Feature}s enabled, as bitmask.

_formatParserFeatures	back to summary
protected int _formatParserFeatures Set of `FromXmlParser.Feature`s enabled, as bitmask.

_nameForTextElement	back to summary
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.

_nameForTextElement

back to summary

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.

_nameProcessor back to summary

_nameProcessor	back to summary
protected XmlNameProcessor _nameProcessor See `XmlNameProcessor` and `XmlNameProcessors` Since 2.14

protected XmlNameProcessor _nameProcessor

See XmlNameProcessor and XmlNameProcessors

Since: 2.14

_xmlInputFactory	back to summary
protected XMLInputFactory _xmlInputFactory Stax factory for creating underlying input stream readers; `null` for "use default instance with default settings"

_xmlOutputFactory	back to summary
protected XMLOutputFactory _xmlOutputFactory Stax factory for creating underlying output stream writers; `null` for "use default instance with default settings"

Constructor Detail

XmlFactoryBuilder	back to summary
protected XmlFactoryBuilder()

XmlFactoryBuilder	back to summary
public XmlFactoryBuilder(XmlFactory base)

Method Detail

build back to summary

build	back to summary
public XmlFactory build() Implements abstract com.fasterxml.jackson.core.TSFBuilder.build. Doc from com.fasterxml.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration. Returns:XmlFactory `TokenStreamFactory` build based on current configuration Annotations @Override

public XmlFactory build()

Implements abstract com.fasterxml.jackson.core.TSFBuilder.build.

Doc from com.fasterxml.jackson.core.TSFBuilder.build.

Method for constructing actual TokenStreamFactory instance, given configuration.

Returns:XmlFactory

TokenStreamFactory build based on current configuration

Annotations

@Override

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

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

defaultInputFactory	back to summary
protected XMLInputFactory defaultInputFactory()

defaultOutputFactory	back to summary
protected XMLOutputFactory defaultOutputFactory()

disable	back to summary
public XmlFactoryBuilder disable(FromXmlParser.Feature f)

disable	back to summary
public XmlFactoryBuilder disable(FromXmlParser.Feature first, FromXmlParser.Feature... other)

disable	back to summary
public XmlFactoryBuilder disable(ToXmlGenerator.Feature f)

disable	back to summary
public XmlFactoryBuilder disable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)

enable	back to summary
public XmlFactoryBuilder enable(FromXmlParser.Feature f)

enable	back to summary
public XmlFactoryBuilder enable(FromXmlParser.Feature first, FromXmlParser.Feature... other)

enable	back to summary
public XmlFactoryBuilder enable(ToXmlGenerator.Feature f)

enable	back to summary
public XmlFactoryBuilder enable(ToXmlGenerator.Feature first, ToXmlGenerator.Feature... other)

formatGeneratorFeaturesMask	back to summary
public int formatGeneratorFeaturesMask()

formatParserFeaturesMask	back to summary
public int formatParserFeaturesMask()

inputFactory	back to summary
public XmlFactoryBuilder inputFactory(XMLInputFactory xmlIn) Deprecated Since 2.13 use `xmlInputFactory()` instead Annotations @Deprecated

nameForTextElement	back to summary
public String nameForTextElement()

nameForTextElement	back to summary
public XmlFactoryBuilder nameForTextElement(String name)

outputFactory	back to summary
public XmlFactoryBuilder outputFactory(XMLOutputFactory xmlOut) Deprecated Since 2.13 use `xmlOutputFactory()` instead Annotations @Deprecated

staxClassLoader	back to summary
protected ClassLoader staxClassLoader()

staxClassLoader back to summary

staxClassLoader	back to summary
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

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

xmlInputFactory	back to summary
public XMLInputFactory xmlInputFactory()

xmlInputFactory	back to summary
public XmlFactoryBuilder xmlInputFactory(XMLInputFactory xmlIn) Since 2.13 (was misnamed as `inputFactory(in) formerly`)

xmlNameProcessor	back to summary
public XmlNameProcessor xmlNameProcessor()

xmlNameProcessor	back to summary
public XmlFactoryBuilder xmlNameProcessor(XmlNameProcessor nameProcessor) Since 2.14

xmlOutputFactory	back to summary
public XMLOutputFactory xmlOutputFactory()

xmlOutputFactory	back to summary
public XmlFactoryBuilder xmlOutputFactory(XMLOutputFactory xmlOut) Since 2.13 (was misnamed as `outputFactory(in) formerly`)

public Class XmlFactoryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail