public abstract class XMLOutputFactory extends Object
Defines an abstract implementation of a factory for getting XMLEventWriters and XMLStreamWriters. The following table defines the standard properties of this specification. Each property varies in the level of support required by each implementation. The level of support required is described in the 'Required' column.
| Configuration parameters | ||||
|---|---|---|---|---|
| Property Name | Behavior | Return type | Default Value | Required |
| javax.xml.stream.isRepairingNamespaces | defaults prefixes on the output side | Boolean | False | Yes |
The following paragraphs describe the namespace and prefix repair algorithm:
The property can be set with the following code line: setProperty("javax.xml.stream.isRepairingNamespaces",new Boolean(true|false));
This property specifies that the writer default namespace prefix declarations. The default value is false.
If a writer isRepairingNamespaces it will create a namespace declaration on the current StartElement for any attribute that does not currently have a namespace declaration in scope. If the StartElement has a uri but no prefix specified a prefix will be assigned, if the prefix has not been declared in a parent of the current StartElement it will be declared on the current StartElement. If the defaultNamespace is bound and in scope and the default namespace matches the URI of the attribute or StartElement QName no prefix will be assigned.
If an element or attribute name has a prefix, but is not bound to any namespace URI, then the prefix will be removed during serialization.
If element and/or attribute names in the same start or empty-element tag are bound to different namespace URIs and are using the same prefix then the element or the first occurring attribute retains the original prefix and the following attributes have their prefixes replaced with a new prefix that is bound to the namespace URIs of those attributes.
If an element or attribute name uses a prefix that is bound to a different URI than that inherited from the namespace context of the parent of that element and there is no namespace declaration in the context of the current element then such a namespace declaration is added.
If an element or attribute name is bound to a prefix and there is a namespace declaration that binds that prefix to a different URI then that namespace declaration is either removed if the correct mapping is inherited from the parent context of that element, or changed to the namespace URI of the element or attribute using that prefix.
XMLInputFactory, XMLEventWriter, XMLStreamWriter
public static final String IS_REPAIRING_NAMESPACES
Property used to set prefix defaulting on the output side
protected XMLOutputFactory()
public static XMLOutputFactory newInstance()
throws FactoryConfigurationError Creates a new instance of the factory in exactly the same manner as the newFactory() method.
FactoryConfigurationError - if an instance of this factory cannot be loadedpublic static XMLOutputFactory newFactory()
throws FactoryConfigurationError Create a new instance of the factory.
This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the XMLOutputFactory implementation class to load:
ServiceLoader class, to attempt to locate and load an implementation of the service using the default loading mechanism: the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used. Once an application has obtained a reference to a XMLOutputFactory it can use the factory to configure and obtain stream instances.
Note that this is a new method that replaces the deprecated newInstance() method. No changes in behavior are defined by this replacement method relative to the deprecated method.
FactoryConfigurationError - in case of service configuration error or if the implementation is not available or cannot be instantiated.public static XMLInputFactory newInstance(String factoryId,
ClassLoader classLoader)
throws FactoryConfigurationError Deprecated. This method has been deprecated because it returns an instance of XMLInputFactory, which is of the wrong class. Use the new method newFactory(java.lang.String,
java.lang.ClassLoader) instead.
Create a new instance of the factory.
factoryId - Name of the factory to find, same as a property nameclassLoader - classLoader to useFactoryConfigurationError - if an instance of this factory cannot be loadedpublic static XMLOutputFactory newFactory(String factoryId,
ClassLoader classLoader)
throws FactoryConfigurationError Create a new instance of the factory. If the classLoader argument is null, then the ContextClassLoader is used.
This method uses the following ordered lookup procedure to determine the XMLOutputFactory implementation class to load:
factoryId. factoryId. factoryId is "javax.xml.stream.XMLOutputFactory", use the service-provider loading facilities, defined by the ServiceLoader class, to attempt to locate and load an implementation of the service using the specified ClassLoader. If classLoader is null, the default loading mechanism will apply: That is, the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used. FactoryConfigurationError. Note that this is a new method that replaces the deprecated newInstance(String factoryId, ClassLoader classLoader) method. The original method was incorrectly defined to return XMLInputFactory.
factoryId - Name of the factory to find, same as a property nameclassLoader - classLoader to useFactoryConfigurationError - in case of service configuration error or if the implementation is not available or cannot be instantiated.public abstract XMLStreamWriter createXMLStreamWriter(Writer stream)
throws XMLStreamException Create a new XMLStreamWriter that writes to a writer
stream - the writer to write toXMLStreamExceptionpublic abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream)
throws XMLStreamException Create a new XMLStreamWriter that writes to a stream
stream - the stream to write toXMLStreamExceptionpublic abstract XMLStreamWriter createXMLStreamWriter(OutputStream stream,
String encoding)
throws XMLStreamException Create a new XMLStreamWriter that writes to a stream
stream - the stream to write toencoding - the encoding to useXMLStreamExceptionpublic abstract XMLStreamWriter createXMLStreamWriter(Result result)
throws XMLStreamException Create a new XMLStreamWriter that writes to a JAXP result. This method is optional.
result - the result to write toUnsupportedOperationException - if this method is not supported by this XMLOutputFactoryXMLStreamExceptionpublic abstract XMLEventWriter createXMLEventWriter(Result result)
throws XMLStreamException Create a new XMLEventWriter that writes to a JAXP result. This method is optional.
result - the result to write toUnsupportedOperationException - if this method is not supported by this XMLOutputFactoryXMLStreamExceptionpublic abstract XMLEventWriter createXMLEventWriter(OutputStream stream)
throws XMLStreamException Create a new XMLEventWriter that writes to a stream
stream - the stream to write toXMLStreamExceptionpublic abstract XMLEventWriter createXMLEventWriter(OutputStream stream,
String encoding)
throws XMLStreamException Create a new XMLEventWriter that writes to a stream
stream - the stream to write toencoding - the encoding to useXMLStreamExceptionpublic abstract XMLEventWriter createXMLEventWriter(Writer stream)
throws XMLStreamException Create a new XMLEventWriter that writes to a writer
stream - the stream to write toXMLStreamExceptionpublic abstract void setProperty(String name,
Object value)
throws IllegalArgumentException Allows the user to set specific features/properties on the underlying implementation.
name - The name of the propertyvalue - The value of the propertyIllegalArgumentException - if the property is not supportedpublic abstract Object getProperty(String name)
throws IllegalArgumentException Get a feature/property on the underlying implementation
name - The name of the propertyIllegalArgumentException - if the property is not supportedpublic abstract boolean isPropertySupported(String name)
Query the set of properties that this factory supports.
name - The name of the property (may not be null)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.