Class StAXUtils
This class defines a set of methods to get XMLStreamReader and XMLStreamWriter
instances. This class caches the corresponding factories, i.e. XMLInputFactory
and XMLOutputFactory objects.
Default properties for these factories can be specified using
XMLInputFactory.properties and XMLOutputFactory.properties files.
These files are loaded using the class loader that loaded the StAXUtils class.
Properties with boolean, integer and string values are supported.
Both standard StAX properties and implementation specific properties can be specified. This
feature should be used with care since changing some properties to non default values will break
Axiom. Good candidates for XMLInputFactory.properties are:
javax.xml.stream.isCoalescing- Requires the processor to coalesce adjacent character data (text nodes and CDATA sections). This property also controls whether CDATA sections are reported or not.
com.ctc.wstx.inputBufferLength- Size of input buffer (in chars), to use for reading XML content from input stream/reader. This property is Woodstox specific.
com.ctc.wstx.minTextSegment- Property to specify shortest non-complete text segment (part of CDATA section or text content) that the parser is allowed to return, if not required to coalesce text. This property is Woodstox specific.
Good candidates for XMLOutputFactory.properties are:
com.ctc.wstx.outputEscapeCr- Property that determines whether Carriage Return (\r) characters are to be escaped when output or not. If enabled, all instances of of character \r are escaped using a character entity (where possible, that is, within CHARACTERS events, and attribute values). Otherwise they are output as is. The main reason to enable this property is to ensure that carriage returns are preserved as is through parsing, since otherwise they will be converted to canonical XML linefeeds (\n), when occurring along or as part of \r\n pair. This property is Woodstox specific.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic XMLStreamReaderstatic XMLStreamReadercreateXMLStreamReader(InputStream in, String encoding) static XMLStreamReaderstatic XMLStreamReadercreateXMLStreamReader(StAXParserConfiguration configuration, InputStream in) static XMLStreamReadercreateXMLStreamReader(StAXParserConfiguration configuration, InputStream in, String encoding) static XMLStreamReadercreateXMLStreamReader(StAXParserConfiguration configuration, Reader in) static XMLStreamReadercreateXMLStreamReader(StAXParserConfiguration configuration, String systemId, InputStream in) static XMLStreamWriterDeprecated.static XMLStreamWritercreateXMLStreamWriter(OutputStream out, String encoding) Deprecated.static XMLStreamWriterDeprecated.static XMLStreamWritercreateXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out) Deprecated.static XMLStreamWritercreateXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out, String encoding) Deprecated.static XMLStreamWritercreateXMLStreamWriter(StAXWriterConfiguration configuration, Writer out) Deprecated.static XMLInputFactoryGet a cachedXMLInputFactoryinstance using the default configuration.static XMLInputFactorygetXMLInputFactory(boolean factoryPerClassLoaderPolicy) Deprecated.static XMLInputFactorygetXMLInputFactory(StAXParserConfiguration configuration) Get a cachedXMLInputFactoryinstance using the specified configuration.static XMLInputFactorygetXMLInputFactory(StAXParserConfiguration configuration, boolean factoryPerClassLoaderPolicy) Deprecated.static XMLOutputFactoryDeprecated.static XMLOutputFactorygetXMLOutputFactory(boolean factoryPerClassLoaderPolicy) Deprecated.static XMLOutputFactorygetXMLOutputFactory(StAXWriterConfiguration configuration) Deprecated.static XMLOutputFactorygetXMLOutputFactory(StAXWriterConfiguration configuration, boolean factoryPerClassLoaderPolicy) Deprecated.static voidsetFactoryPerClassLoader(boolean value) Deprecated.Per class loader factories are no longer supported.
-
Constructor Details
-
StAXUtils
public StAXUtils()
-
-
Method Details
-
getXMLInputFactory
Get a cachedXMLInputFactoryinstance using the default configuration.- Returns:
- an
XMLInputFactoryinstance.
-
getXMLInputFactory
Deprecated.Get a cachedXMLInputFactoryinstance using the default configuration and the specified cache policy.- Parameters:
factoryPerClassLoaderPolicy- the cache policy; seegetXMLInputFactory(StAXParserConfiguration, boolean)for more details- Returns:
- an
XMLInputFactoryinstance.
-
getXMLInputFactory
public static XMLInputFactory getXMLInputFactory(StAXParserConfiguration configuration, boolean factoryPerClassLoaderPolicy) Deprecated.Get a cachedXMLInputFactoryinstance using the specified configuration and cache policy.- Parameters:
configuration- the configuration applied to the requested factoryfactoryPerClassLoaderPolicy- If set totrue, the factory cached for the current class loader will be returned. If set tofalse, the singleton factory (instantiated using the class loader that loadedStAXUtils) will be returned.- Returns:
- an
XMLInputFactoryinstance.
-
createXMLStreamReader
public static XMLStreamReader createXMLStreamReader(InputStream in, String encoding) throws XMLStreamException - Throws:
XMLStreamException
-
createXMLStreamReader
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, InputStream in, String encoding) throws XMLStreamException - Throws:
XMLStreamException
-
createXMLStreamReader
- Throws:
XMLStreamException
-
createXMLStreamReader
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, InputStream in) throws XMLStreamException - Throws:
XMLStreamException
-
createXMLStreamReader
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, String systemId, InputStream in) throws XMLStreamException - Throws:
XMLStreamException
-
createXMLStreamReader
- Throws:
XMLStreamException
-
createXMLStreamReader
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, Reader in) throws XMLStreamException - Throws:
XMLStreamException
-
getXMLOutputFactory
Deprecated.Get a cachedXMLOutputFactoryinstance using the default configuration.- Returns:
- an
XMLOutputFactoryinstance.
-
getXMLOutputFactory
Deprecated.Get a cachedXMLOutputFactoryinstance using the default configuration and the specified cache policy.- Parameters:
factoryPerClassLoaderPolicy- the cache policy; seegetXMLOutputFactory(StAXWriterConfiguration, boolean)for more details- Returns:
- an
XMLOutputFactoryinstance.
-
getXMLOutputFactory
public static XMLOutputFactory getXMLOutputFactory(StAXWriterConfiguration configuration, boolean factoryPerClassLoaderPolicy) Deprecated.Get a cachedXMLOutputFactoryinstance using the specified configuration and cache policy.- Parameters:
configuration- the configuration applied to the requested factoryfactoryPerClassLoaderPolicy- If set totrue, the factory cached for the current class loader will be returned. If set tofalse, the singleton factory (instantiated using the class loader that loadedStAXUtils) will be returned.- Returns:
- an
XMLOutputFactoryinstance.
-
setFactoryPerClassLoader
public static void setFactoryPerClassLoader(boolean value) Deprecated.Per class loader factories are no longer supported. The code now always uses the class loader that loaded theStAXUtilsclass. -
createXMLStreamWriter
Deprecated.- Throws:
XMLStreamException
-
createXMLStreamWriter
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out) throws XMLStreamException Deprecated.- Throws:
XMLStreamException
-
createXMLStreamWriter
public static XMLStreamWriter createXMLStreamWriter(OutputStream out, String encoding) throws XMLStreamException Deprecated.- Throws:
XMLStreamException
-
createXMLStreamWriter
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out, String encoding) throws XMLStreamException Deprecated.- Throws:
XMLStreamException
-
createXMLStreamWriter
Deprecated.- Throws:
XMLStreamException
-
createXMLStreamWriter
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, Writer out) throws XMLStreamException Deprecated.- Throws:
XMLStreamException
-
getXMLInputFactory
Get a cachedXMLInputFactoryinstance using the specified configuration.- Parameters:
configuration- the configuration applied to the requested factory- Returns:
- an
XMLInputFactoryinstance.
-
getXMLOutputFactory
Deprecated.Get a cachedXMLOutputFactoryinstance using the specified configuration.- Parameters:
configuration- the configuration applied to the requested factory- Returns:
- an
XMLOutputFactoryinstance.
-