Jackson 3.0.1 · tools.jackson.dataformat.xml.XmlFactoryBuilder

Field Summary

Modifier and Type	Field and Description
protected ClassLoader	_classLoaderForStax Optional `ClassLoader` to use for constructing `XMLInputFactory` and `XMLOutputFactory` instances if not explicitly specified by caller.
protected int	_formatGeneratorFeatures Set of `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 tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder:: _generatorDecorators _inputDecorator _outputDecorator

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 tools.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration.
public XmlFactoryBuilder	configure(XmlReadFeature f, boolean state)
public XmlFactoryBuilder	configure(XmlWriteFeature f, boolean state)
protected XMLInputFactory	defaultXmlInputFactory()
protected static XMLInputFactory	defaultXmlInputFactory(ClassLoader cl)
protected XMLOutputFactory	defaultXmlOutputFactory()
protected static XMLOutputFactory	defaultXmlOutputFactory(ClassLoader cl)
public XmlFactoryBuilder	disable(XmlReadFeature f)
public XmlFactoryBuilder	disable(XmlReadFeature first, XmlReadFeature... other)
public XmlFactoryBuilder	disable(XmlWriteFeature f)
public XmlFactoryBuilder	disable(XmlWriteFeature first, XmlWriteFeature... other)
public XmlFactoryBuilder	enable(XmlReadFeature f)
public XmlFactoryBuilder	enable(XmlReadFeature first, XmlReadFeature... other)
public XmlFactoryBuilder	enable(XmlWriteFeature f)
public XmlFactoryBuilder	enable(XmlWriteFeature first, XmlWriteFeature... other)
public String	nameForTextElement()
public XmlFactoryBuilder	nameForTextElement(String name)
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)

Inherited from tools.jackson.core.base.DecorableTSFactory.DecorableTSFBuilder:: addDecorator generatorDecorators inputDecorator inputDecorator outputDecorator outputDecorator

Field Detail

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

_formatGeneratorFeatures	back to summary
protected int _formatGeneratorFeatures Set of `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 inter-operability 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 inter-operability reasons: JAXB, for example, uses "value" as name.

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

_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 tools.jackson.core.TSFBuilder.build. Doc from tools.jackson.core.TSFBuilder.build. Method for constructing actual `TokenStreamFactory` instance, given configuration. Annotations @Override

public XmlFactory build()

Implements abstract tools.jackson.core.TSFBuilder.build.

Doc from tools.jackson.core.TSFBuilder.build.

Method for constructing actual TokenStreamFactory instance, given configuration.

Annotations

@Override

configure	back to summary
public XmlFactoryBuilder configure(XmlReadFeature f, boolean state)

configure	back to summary
public XmlFactoryBuilder configure(XmlWriteFeature f, boolean state)

defaultXmlInputFactory	back to summary
protected XMLInputFactory defaultXmlInputFactory()

defaultXmlInputFactory	back to summary
protected static XMLInputFactory defaultXmlInputFactory(ClassLoader cl)

defaultXmlOutputFactory	back to summary
protected XMLOutputFactory defaultXmlOutputFactory()

defaultXmlOutputFactory	back to summary
protected static XMLOutputFactory defaultXmlOutputFactory(ClassLoader cl)

disable	back to summary
public XmlFactoryBuilder disable(XmlReadFeature f)

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

disable	back to summary
public XmlFactoryBuilder disable(XmlWriteFeature f)

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

enable	back to summary
public XmlFactoryBuilder enable(XmlReadFeature f)

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

enable	back to summary
public XmlFactoryBuilder enable(XmlWriteFeature f)

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

nameForTextElement	back to summary
public String nameForTextElement()

nameForTextElement	back to summary
public XmlFactoryBuilder nameForTextElement(String name)

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.

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.

xmlInputFactory	back to summary
public XMLInputFactory xmlInputFactory()

xmlInputFactory	back to summary
public XmlFactoryBuilder xmlInputFactory(XMLInputFactory xmlIn)

xmlNameProcessor	back to summary
public XmlNameProcessor xmlNameProcessor()

xmlNameProcessor	back to summary
public XmlFactoryBuilder xmlNameProcessor(XmlNameProcessor nameProcessor)

xmlOutputFactory	back to summary
public XMLOutputFactory xmlOutputFactory()

xmlOutputFactory	back to summary
public XmlFactoryBuilder xmlOutputFactory(XMLOutputFactory xmlOut)

public Class XmlFactoryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail