javax.xml.stream

Class XMLOutputFactory

java.lang.Object

javax.xml.stream.XMLOutputFactory

public abstract class XMLOutputFactory
extends java.lang.Object

Factory for obtaining XML stream and event writers for various kinds of output sink.

Configuration

Name	Description	Type	Default	Required
javax.xml.stream.isRepairingNamespaces	default namespace prefixes	Boolean	Boolean.FALSE	yes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_REPAIRING_NAMESPACES Property used to control whether to default namespace prefixes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLOutputFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract XMLEventWriter	createXMLEventWriter(java.io.OutputStream stream) Creates a new event writer.
abstract XMLEventWriter	createXMLEventWriter(java.io.OutputStream stream, java.lang.String encoding) Creates a new event writer.
abstract XMLEventWriter	createXMLEventWriter(javax.xml.transform.Result result) Creates a new event writer.
abstract XMLEventWriter	createXMLEventWriter(java.io.Writer stream) Creates a new event writer.
abstract XMLStreamWriter	createXMLStreamWriter(java.io.OutputStream stream) Creates a new stream writer.
abstract XMLStreamWriter	createXMLStreamWriter(java.io.OutputStream stream, java.lang.String encoding) Creates a new stream writer.
abstract XMLStreamWriter	createXMLStreamWriter(javax.xml.transform.Result result) Creates a new stream writer.
abstract XMLStreamWriter	createXMLStreamWriter(java.io.Writer stream) Creates a new stream writer.
abstract java.lang.Object	getProperty(java.lang.String name) Returns the implementation-specific property of the given name.
abstract boolean	isPropertySupported(java.lang.String name) Indicates whether the specified property is supported.
static XMLOutputFactory	newInstance() Creates a new output factory.
static XMLOutputFactory	newInstance(java.lang.String factoryId, java.lang.ClassLoader classLoader) Creates a new output factory.
abstract void	setProperty(java.lang.String name, java.lang.Object value) Sets the implementation-specific property of the given name.

Methods inherited from class java.lang.Object

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

Field Detail

IS_REPAIRING_NAMESPACES

public static final java.lang.String IS_REPAIRING_NAMESPACES

Property used to control whether to default namespace prefixes. If true, the writer will create a namespace declaration for any attribute that doesn't have a namespace declaration in scope.

See Also:

Constant Field Values

Constructor Detail

XMLOutputFactory

protected XMLOutputFactory()

Method Detail

newInstance

public static XMLOutputFactory newInstance()
                                    throws FactoryConfigurationError

Creates a new output factory.

Throws:

FactoryConfigurationError

See Also:

newInstance(String,ClassLoader)

newInstance

public static XMLOutputFactory newInstance(java.lang.String factoryId,
                           java.lang.ClassLoader classLoader)
                                    throws FactoryConfigurationError

Creates a new output factory. The implementation class to load is the first found in the following locations:

1. the javax.xml.stream.XMLOutputFactory system property
2. the above named property value in the $JAVA_HOME/lib/stax.properties file
3. the class name specified in the META-INF/services/javax.xml.stream.XMLOutputFactory system resource
4. the default factory class

Parameters:

factoryId - the name of the factory, same as the property

classLoader - the class loader to use

Returns:

a new factory instance

Throws:

FactoryConfigurationError - if an instance of this factory could not be loaded

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.Writer stream)
                                               throws XMLStreamException

Creates a new stream writer.

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream)
                                               throws XMLStreamException

Creates a new stream writer.

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(java.io.OutputStream stream,
                                    java.lang.String encoding)
                                               throws XMLStreamException

Creates a new stream writer.

Throws:

XMLStreamException

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(javax.xml.transform.Result result)
                                               throws XMLStreamException

Creates a new stream writer.

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(javax.xml.transform.Result result)
                                             throws XMLStreamException

Creates a new event writer.

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream)
                                             throws XMLStreamException

Creates a new event writer.

Throws:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.OutputStream stream,
                                  java.lang.String encoding)
                                             throws XMLStreamException

Creates a new event writer.

Throws:

XMLStreamException

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(java.io.Writer stream)
                                             throws XMLStreamException

Creates a new event writer.

Throws:

XMLStreamException

setProperty

public abstract void setProperty(java.lang.String name,
               java.lang.Object value)
                          throws java.lang.IllegalArgumentException

Sets the implementation-specific property of the given name.

Throws:

java.lang.IllegalArgumentException - if the property is not supported

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws java.lang.IllegalArgumentException

Returns the implementation-specific property of the given name.

Throws:

java.lang.IllegalArgumentException - if the property is not supported

isPropertySupported

public abstract boolean isPropertySupported(java.lang.String name)

Indicates whether the specified property is supported.