public class StAXUtils extends Object
This class defines a set of methods to get XMLStreamReader
and XMLStreamWriter
instances. This class caches the corresponding factories (XMLInputFactory
and XMLOutputFactory
objects) by classloader (default) or as singletons.
The behavior can be changed using setFactoryPerClassLoader(boolean)
.
Default properties for these factories can be specified using XMLInputFactory.properties and XMLOutputFactory.properties files. When a new factory is instantiated, this class will attempt to load the corresponding file using the context classloader. This class supports properties with boolean, integer and string values. 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:
Good candidates for XMLOutputFactory.properties are:
Constructor and Description |
---|
StAXUtils() |
Modifier and Type | Method and Description |
---|---|
static XMLStreamReader |
createNetworkDetachedXMLStreamReader(InputStream in)
|
static XMLStreamReader |
createNetworkDetachedXMLStreamReader(InputStream in,
String encoding)
|
static XMLStreamReader |
createNetworkDetachedXMLStreamReader(Reader in)
Deprecated.
|
static XMLStreamReader |
createXMLStreamReader(InputStream in) |
static XMLStreamReader |
createXMLStreamReader(InputStream in,
String encoding) |
static XMLStreamReader |
createXMLStreamReader(Reader in) |
static XMLStreamReader |
createXMLStreamReader(StAXParserConfiguration configuration,
InputStream in) |
static XMLStreamReader |
createXMLStreamReader(StAXParserConfiguration configuration,
InputStream in,
String encoding) |
static XMLStreamReader |
createXMLStreamReader(StAXParserConfiguration configuration,
Reader in) |
static XMLStreamReader |
createXMLStreamReader(StAXParserConfiguration configuration,
String systemId,
InputStream in) |
static XMLStreamWriter |
createXMLStreamWriter(OutputStream out) |
static XMLStreamWriter |
createXMLStreamWriter(OutputStream out,
String encoding) |
static XMLStreamWriter |
createXMLStreamWriter(StAXWriterConfiguration configuration,
OutputStream out) |
static XMLStreamWriter |
createXMLStreamWriter(StAXWriterConfiguration configuration,
OutputStream out,
String encoding) |
static XMLStreamWriter |
createXMLStreamWriter(StAXWriterConfiguration configuration,
Writer out) |
static XMLStreamWriter |
createXMLStreamWriter(Writer out) |
static String |
getEventTypeString(int event)
Deprecated.
Use
XMLEventUtils.getEventTypeString(int) instead |
static XMLInputFactory |
getNetworkDetachedXMLInputFactory()
Deprecated.
|
static XMLInputFactory |
getXMLInputFactory()
Get a cached
XMLInputFactory instance using the default
configuration and cache policy (i.e. |
static XMLInputFactory |
getXMLInputFactory(boolean factoryPerClassLoaderPolicy)
Get a cached
XMLInputFactory instance using the default
configuration and the specified cache policy. |
static XMLInputFactory |
getXMLInputFactory(StAXParserConfiguration configuration)
Get a cached
XMLInputFactory instance using the specified
configuration and the default cache policy. |
static XMLInputFactory |
getXMLInputFactory(StAXParserConfiguration configuration,
boolean factoryPerClassLoaderPolicy)
Get a cached
XMLInputFactory instance using the specified
configuration and cache policy. |
static XMLOutputFactory |
getXMLOutputFactory()
Get a cached
XMLOutputFactory instance using the default
configuration and cache policy (i.e. |
static XMLOutputFactory |
getXMLOutputFactory(boolean factoryPerClassLoaderPolicy)
Get a cached
XMLOutputFactory instance using the default
configuration and the specified cache policy. |
static XMLOutputFactory |
getXMLOutputFactory(StAXWriterConfiguration configuration)
Get a cached
XMLOutputFactory instance using the specified
configuration and the default cache policy. |
static XMLOutputFactory |
getXMLOutputFactory(StAXWriterConfiguration configuration,
boolean factoryPerClassLoaderPolicy)
Get a cached
XMLOutputFactory instance using the specified
configuration and cache policy. |
static void |
releaseXMLInputFactory(XMLInputFactory factory)
Deprecated.
Returns an XMLInputFactory instance for reuse.
|
static void |
releaseXMLOutputFactory(XMLOutputFactory factory)
Deprecated.
Returns an XMLOutputFactory instance for reuse.
|
static void |
reset()
Deprecated.
|
static void |
setFactoryPerClassLoader(boolean value)
Set the policy for how to maintain the XMLInputFactory and XMLOutputFactory
|
public static XMLInputFactory getXMLInputFactory()
XMLInputFactory
instance using the default
configuration and cache policy (i.e. one instance per class loader).XMLInputFactory
instance.public static XMLInputFactory getXMLInputFactory(StAXParserConfiguration configuration)
XMLInputFactory
instance using the specified
configuration and the default cache policy.configuration
- the configuration applied to the requested factoryXMLInputFactory
instance.public static XMLInputFactory getXMLInputFactory(boolean factoryPerClassLoaderPolicy)
XMLInputFactory
instance using the default
configuration and the specified cache policy.factoryPerClassLoaderPolicy
- the cache policy; see
getXMLInputFactory(StAXParserConfiguration, boolean)
for more detailsXMLInputFactory
instance.public static XMLInputFactory getXMLInputFactory(StAXParserConfiguration configuration, boolean factoryPerClassLoaderPolicy)
XMLInputFactory
instance using the specified
configuration and cache policy.configuration
- the configuration applied to the requested factoryfactoryPerClassLoaderPolicy
- If set to true
, the factory cached for the
current class loader will be returned. If set to
false
, the singleton factory (instantiated using
the class loader that loaded StAXUtils
) will be
returned.XMLInputFactory
instance.public static void releaseXMLInputFactory(XMLInputFactory factory)
factory
- An XMLInputFactory instance that is available for reusepublic static XMLStreamReader createXMLStreamReader(InputStream in, String encoding) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, InputStream in, String encoding) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(InputStream in) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, InputStream in) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, String systemId, InputStream in) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(Reader in) throws XMLStreamException
XMLStreamException
public static XMLStreamReader createXMLStreamReader(StAXParserConfiguration configuration, Reader in) throws XMLStreamException
XMLStreamException
public static XMLOutputFactory getXMLOutputFactory()
XMLOutputFactory
instance using the default
configuration and cache policy (i.e. one instance per class loader).XMLOutputFactory
instance.public static XMLOutputFactory getXMLOutputFactory(StAXWriterConfiguration configuration)
XMLOutputFactory
instance using the specified
configuration and the default cache policy.configuration
- the configuration applied to the requested factoryXMLOutputFactory
instance.public static XMLOutputFactory getXMLOutputFactory(boolean factoryPerClassLoaderPolicy)
XMLOutputFactory
instance using the default
configuration and the specified cache policy.factoryPerClassLoaderPolicy
- the cache policy; see
getXMLOutputFactory(StAXWriterConfiguration, boolean)
for more detailsXMLOutputFactory
instance.public static XMLOutputFactory getXMLOutputFactory(StAXWriterConfiguration configuration, boolean factoryPerClassLoaderPolicy)
XMLOutputFactory
instance using the specified
configuration and cache policy.configuration
- the configuration applied to the requested factoryfactoryPerClassLoaderPolicy
- If set to true
, the factory cached for the
current class loader will be returned. If set to
false
, the singleton factory (instantiated using
the class loader that loaded StAXUtils
) will be
returned.XMLOutputFactory
instance.public static void setFactoryPerClassLoader(boolean value)
value
- (if false, then one singleton...if true...then singleton per class loader
(default is true)public static void releaseXMLOutputFactory(XMLOutputFactory factory)
factory
- An XMLOutputFactory instance that is available for reuse.public static XMLStreamWriter createXMLStreamWriter(OutputStream out) throws XMLStreamException
XMLStreamException
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out) throws XMLStreamException
XMLStreamException
public static XMLStreamWriter createXMLStreamWriter(OutputStream out, String encoding) throws XMLStreamException
XMLStreamException
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, OutputStream out, String encoding) throws XMLStreamException
XMLStreamException
public static XMLStreamWriter createXMLStreamWriter(Writer out) throws XMLStreamException
XMLStreamException
public static XMLStreamWriter createXMLStreamWriter(StAXWriterConfiguration configuration, Writer out) throws XMLStreamException
XMLStreamException
public static void reset()
public static XMLStreamReader createNetworkDetachedXMLStreamReader(InputStream in, String encoding) throws XMLStreamException
createXMLStreamReader(StAXParserConfiguration, InputStream, String)
with StAXParserConfiguration.STANDALONE
XMLStreamException
public static XMLInputFactory getNetworkDetachedXMLInputFactory()
getXMLInputFactory(StAXParserConfiguration)
with
StAXParserConfiguration.STANDALONE
public static XMLStreamReader createNetworkDetachedXMLStreamReader(InputStream in) throws XMLStreamException
createXMLStreamReader(StAXParserConfiguration, InputStream)
with StAXParserConfiguration.STANDALONE
XMLStreamException
public static XMLStreamReader createNetworkDetachedXMLStreamReader(Reader in) throws XMLStreamException
createXMLStreamReader(StAXParserConfiguration, Reader)
with StAXParserConfiguration.STANDALONE
XMLStreamException
public static String getEventTypeString(int event)
XMLEventUtils.getEventTypeString(int)
insteadCopyright © 2004–2018 The Apache Software Foundation. All rights reserved.