public abstract class XMLInputFactory extends Object
Defines an abstract implementation of a factory for getting streams. 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.isValidating | Turns on/off implementation specific DTD validation | Boolean | False | No |
| javax.xml.stream.isNamespaceAware | Turns on/off namespace processing for XML 1.0 support | Boolean | True | True (required) / False (optional) |
| javax.xml.stream.isCoalescing | Requires the processor to coalesce adjacent character data | Boolean | False | Yes |
| javax.xml.stream.isReplacingEntityReferences | replace internal entity references with their replacement text and report them as characters | Boolean | True | Yes |
| javax.xml.stream.isSupportingExternalEntities | Resolve external parsed entities | Boolean | Unspecified | Yes |
| javax.xml.stream.supportDTD | Use this property to request processors that do not support DTDs | Boolean | True | Yes |
| javax.xml.stream.reporter | sets/gets the impl of the XMLReporter | javax.xml.stream.XMLReporter | Null | Yes |
| javax.xml.stream.resolver | sets/gets the impl of the XMLResolver interface | javax.xml.stream.XMLResolver | Null | Yes |
| javax.xml.stream.allocator | sets/gets the impl of the XMLEventAllocator interface | javax.xml.stream.util.XMLEventAllocator | Null | Yes |
XMLOutputFactory, XMLEventReader, XMLStreamReader, EventFilter, XMLReporter, XMLResolver, XMLEventAllocator
public static final String IS_NAMESPACE_AWARE
The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supported
public static final String IS_VALIDATING
The property used to turn on/off implementation specific validation
public static final String IS_COALESCING
The property that requires the parser to coalesce adjacent character data sections
public static final String IS_REPLACING_ENTITY_REFERENCES
Requires the parser to replace internal entity references with their replacement text and report them as characters
public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
The property that requires the parser to resolve external parsed entities
public static final String SUPPORT_DTD
The property that requires the parser to support DTDs
public static final String REPORTER
The property used to set/get the implementation of the XMLReporter interface
public static final String RESOLVER
The property used to set/get the implementation of the XMLResolver
public static final String ALLOCATOR
The property used to set/get the implementation of the allocator
protected XMLInputFactory()
public static XMLInputFactory 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 XMLInputFactory 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 XMLInputFactory 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 XMLInputFactory 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 to maintain API consistency. All newInstance methods have been replaced with corresponding newFactory methods. The replacement newFactory(java.lang.String, java.lang.ClassLoader) method defines no changes in behavior.
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 XMLInputFactory 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 XMLInputFactory implementation class to load:
factoryId. factoryId. factoryId is "javax.xml.stream.XMLInputFactory", 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. No changes in behavior are defined by this replacement method relative to the deprecated method.
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.FactoryConfigurationError - if an instance of this factory cannot be loadedpublic abstract XMLStreamReader createXMLStreamReader(Reader reader)
throws XMLStreamException Create a new XMLStreamReader from a reader
reader - the XML data to read fromXMLStreamExceptionpublic abstract XMLStreamReader createXMLStreamReader(Source source)
throws XMLStreamException Create a new XMLStreamReader from a JAXP source. This method is optional.
source - the source to read fromUnsupportedOperationException - if this method is not supported by this XMLInputFactoryXMLStreamExceptionpublic abstract XMLStreamReader createXMLStreamReader(InputStream stream)
throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream
stream - the InputStream to read fromXMLStreamExceptionpublic abstract XMLStreamReader createXMLStreamReader(InputStream stream,
String encoding)
throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream
stream - the InputStream to read fromencoding - the character encoding of the streamXMLStreamExceptionpublic abstract XMLStreamReader createXMLStreamReader(String systemId,
InputStream stream)
throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream
systemId - the system ID of the streamstream - the InputStream to read fromXMLStreamExceptionpublic abstract XMLStreamReader createXMLStreamReader(String systemId,
Reader reader)
throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream
systemId - the system ID of the streamreader - the InputStream to read fromXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(Reader reader)
throws XMLStreamException Create a new XMLEventReader from a reader
reader - the XML data to read fromXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(String systemId,
Reader reader)
throws XMLStreamException Create a new XMLEventReader from a reader
systemId - the system ID of the inputreader - the XML data to read fromXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
throws XMLStreamException Create a new XMLEventReader from an XMLStreamReader. After being used to construct the XMLEventReader instance returned from this method the XMLStreamReader must not be used.
reader - the XMLStreamReader to read from (may not be modified)XMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(Source source)
throws XMLStreamException Create a new XMLEventReader from a JAXP source. Support of this method is optional.
source - the source to read fromUnsupportedOperationException - if this method is not supported by this XMLInputFactoryXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(InputStream stream)
throws XMLStreamException Create a new XMLEventReader from a java.io.InputStream
stream - the InputStream to read fromXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(InputStream stream,
String encoding)
throws XMLStreamException Create a new XMLEventReader from a java.io.InputStream
stream - the InputStream to read fromencoding - the character encoding of the streamXMLStreamExceptionpublic abstract XMLEventReader createXMLEventReader(String systemId,
InputStream stream)
throws XMLStreamException Create a new XMLEventReader from a java.io.InputStream
systemId - the system ID of the streamstream - the InputStream to read fromXMLStreamExceptionpublic abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,
StreamFilter filter)
throws XMLStreamException Create a filtered reader that wraps the filter around the reader
reader - the reader to filterfilter - the filter to apply to the readerXMLStreamExceptionpublic abstract XMLEventReader createFilteredReader(XMLEventReader reader,
EventFilter filter)
throws XMLStreamException Create a filtered event reader that wraps the filter around the event reader
reader - the event reader to wrapfilter - the filter to apply to the event readerXMLStreamExceptionpublic abstract XMLResolver getXMLResolver()
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
public abstract void setXMLResolver(XMLResolver resolver)
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
resolver - the resolver to use to resolve referencespublic abstract XMLReporter getXMLReporter()
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
public abstract void setXMLReporter(XMLReporter reporter)
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
reporter - the resolver to use to report non fatal errorspublic abstract void setProperty(String name,
Object value)
throws IllegalArgumentException Allows the user to set specific feature/property on the underlying implementation. The underlying implementation is not required to support every setting of every property in the specification and may use IllegalArgumentException to signal that an unsupported property may not be set with the specified value.
All implementations that implement JAXP 1.5 or newer are required to support the XMLConstants.ACCESS_EXTERNAL_DTD property.
Access to external DTDs, external Entity References is restricted to the protocols specified by the property. If access is denied during parsing due to the restriction of this property, XMLStreamException will be thrown by the XMLStreamReader.next() or XMLEventReader.nextEvent() method.
name - The name of the property (may not be null)value - The value of the propertyIllegalArgumentException - if the property is not supportedpublic abstract Object getProperty(String name)
throws IllegalArgumentException Get the value of a feature/property from the underlying implementation
name - The name of the property (may not be null)IllegalArgumentException - 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)public abstract void setEventAllocator(XMLEventAllocator allocator)
Set a user defined event allocator for events
allocator - the user defined allocatorpublic abstract XMLEventAllocator getEventAllocator()
Gets the allocator used by streams created with this factory
© 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.