javax.xml.stream

Class XMLOutputFactory

public abstract class XMLOutputFactory extends 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
static String	IS_REPAIRING_NAMESPACES Property used to control whether to default namespace prefixes.

Constructor Summary
protected	XMLOutputFactory()

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

Field Detail

IS_REPAIRING_NAMESPACES

public static final 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.

Constructor Detail

XMLOutputFactory

protected XMLOutputFactory()

Method Detail

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(Result result)

Creates a new event writer.

Throws: UnsupportedOperationException if this method is not supported

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(OutputStream stream)

Creates a new event writer.

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(OutputStream stream, String encoding)

Creates a new event writer.

createXMLEventWriter

public abstract XMLEventWriter createXMLEventWriter(Writer stream)

Creates a new event writer.

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(Writer stream)

Creates a new stream writer.

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream)

Creates a new stream writer.

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream, String encoding)

Creates a new stream writer.

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(Result result)

Creates a new stream writer.

Throws: UnsupportedOperationException if this method is not supported

getProperty

public abstract Object getProperty(String name)

Returns the implementation-specific property of the given name.

Throws: IllegalArgumentException if the property is not supported

isPropertySupported

public abstract boolean isPropertySupported(String name)

Indicates whether the specified property is supported.

newInstance

public static XMLOutputFactory newInstance()

Creates a new output factory.

newInstance

public static XMLOutputFactory newInstance(String factoryId, ClassLoader classLoader)

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

the javax.xml.stream.XMLOutputFactory system property
the above named property value in the $JAVA_HOME/lib/stax.properties file
the class name specified in the META-INF/services/javax.xml.stream.XMLOutputFactory system resource
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

setProperty

public abstract void setProperty(String name, Object value)

Sets the implementation-specific property of the given name.

Throws: IllegalArgumentException if the property is not supported