public abstract class XMLInputFactory extends Object
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 |
Modifier and Type | Field | Description |
---|---|---|
static final String |
ALLOCATOR |
The property used to set/get the implementation of the allocator |
static final String |
IS_COALESCING |
The property that requires the parser to coalesce adjacent character data sections |
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 |
static final String |
IS_REPLACING_ENTITY_REFERENCES |
Requires the parser to replace internal entity references with their replacement text and report them as characters |
static final String |
IS_SUPPORTING_EXTERNAL_ENTITIES |
The property that requires the parser to resolve external parsed entities |
static final String |
IS_VALIDATING |
The property used to turn on/off implementation specific validation |
static final String |
REPORTER |
The property used to set/get the implementation of the XMLReporter interface |
static final String |
RESOLVER |
The property used to set/get the implementation of the XMLResolver |
static final String |
SUPPORT_DTD |
The property that requires the parser to support DTDs |
Modifier | Constructor | Description |
---|---|---|
protected |
Protected constructor to prevent instantiation. |
Modifier and Type | Method | Description |
---|---|---|
abstract XMLEventReader |
createFilteredReader |
Create a filtered event reader that wraps the filter around the event reader |
abstract XMLStreamReader |
createFilteredReader |
Create a filtered reader that wraps the filter around the reader |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a java.io.InputStream |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a java.io.InputStream |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a reader. |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a java.io.InputStream |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a reader. |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from an XMLStreamReader. |
abstract XMLEventReader |
createXMLEventReader |
Create a new XMLEventReader from a JAXP source. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a java.io.InputStream. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a java.io.InputStream. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a reader. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a java.io.InputStream. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a java.io.InputStream. |
abstract XMLStreamReader |
createXMLStreamReader |
Create a new XMLStreamReader from a JAXP source. |
abstract XMLEventAllocator |
getEventAllocator() |
Gets the allocator used by streams created with this factory |
abstract Object |
getProperty |
Get the value of a feature/property from the underlying implementation |
abstract XMLReporter |
getXMLReporter() |
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
abstract XMLResolver |
getXMLResolver() |
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
abstract boolean |
isPropertySupported |
Query the set of properties that this factory supports. |
static XMLInputFactory |
newDefaultFactory() |
Creates a new instance of the XMLInputFactory builtin system-default implementation. |
static XMLInputFactory |
newFactory() |
Creates a new instance of the factory. |
static XMLInputFactory |
newFactory |
Create a new instance of the factory. |
static XMLInputFactory |
newInstance() |
Creates a new instance of the factory in exactly the same manner as the newFactory() method. |
static XMLInputFactory |
newInstance |
Deprecated. This method has been deprecated to maintain API consistency. |
abstract void |
setEventAllocator |
Set a user defined event allocator for events |
abstract void |
setProperty |
Allows the user to set specific feature/property on the underlying implementation. |
abstract void |
setXMLReporter |
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
abstract void |
setXMLResolver |
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. |
public static final String IS_NAMESPACE_AWARE
public static final String IS_VALIDATING
public static final String IS_COALESCING
public static final String IS_REPLACING_ENTITY_REFERENCES
public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
public static final String SUPPORT_DTD
public static final String REPORTER
public static final String RESOLVER
public static final String ALLOCATOR
protected XMLInputFactory()
newFactory()
instead.public static XMLInputFactory newDefaultFactory()
XMLInputFactory
builtin system-default implementation.XMLInputFactory
builtin system-default implementation.public static XMLInputFactory newInstance() throws FactoryConfigurationError
newFactory()
method.XMLInputFactory
FactoryConfigurationError
- if an instance of this factory cannot be loadedpublic static XMLInputFactory newFactory() throws FactoryConfigurationError
XMLInputFactory
implementation class to load. Once an application has obtained a reference to a XMLInputFactory
, it can use the factory to configure and obtain stream instances.
XMLInputFactory
FactoryConfigurationError
- in case of service configuration error or if the implementation is not available or cannot be instantiated.@Deprecated(since="1.7") public static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError
newFactory(java.lang.String, java.lang.ClassLoader)
method defines no changes in behavior.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
This method uses the following ordered lookup procedure to determine the XMLInputFactory implementation class to load:
Use the value of the system property identified by factoryId
.
Use the value of the property factoryId
set in the configuration file, jaxp.properties by default. If the file exists and the property factoryId
is specified in the file, its value will be used as the implementation class.
If factoryId
is "javax.xml.stream.XMLInputFactory", use the service-provider loading facility, 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.
Otherwise, throws a 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
reader
- the XML data to read fromXMLStreamReader
XMLStreamException
- if an error occurspublic abstract XMLStreamReader createXMLStreamReader(Source source) throws XMLStreamException
source
- the source to read fromXMLStreamReader
UnsupportedOperationException
- if this method is not supported by this XMLInputFactoryXMLStreamException
- if an error occurspublic abstract XMLStreamReader createXMLStreamReader(InputStream stream) throws XMLStreamException
stream
- the InputStream to read fromXMLStreamReader
XMLStreamException
- if an error occurspublic abstract XMLStreamReader createXMLStreamReader(InputStream stream, String encoding) throws XMLStreamException
stream
- the InputStream to read fromencoding
- the character encoding of the streamXMLStreamReader
XMLStreamException
- if an error occurspublic abstract XMLStreamReader createXMLStreamReader(String systemId, InputStream stream) throws XMLStreamException
systemId
- the system ID of the streamstream
- the InputStream to read fromXMLStreamReader
XMLStreamException
- if an error occurspublic abstract XMLStreamReader createXMLStreamReader(String systemId, Reader reader) throws XMLStreamException
systemId
- the system ID of the streamreader
- the InputStream to read fromXMLStreamReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(Reader reader) throws XMLStreamException
reader
- the XML data to read fromXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(String systemId, Reader reader) throws XMLStreamException
systemId
- the system ID of the inputreader
- the XML data to read fromXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(XMLStreamReader reader) throws XMLStreamException
reader
- the XMLStreamReader to read from (may not be modified)XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(Source source) throws XMLStreamException
source
- the source to read fromXMLEventReader
XMLStreamException
- if an error occursUnsupportedOperationException
- if this method is not supported by this XMLInputFactorypublic abstract XMLEventReader createXMLEventReader(InputStream stream) throws XMLStreamException
stream
- the InputStream to read fromXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(InputStream stream, String encoding) throws XMLStreamException
stream
- the InputStream to read fromencoding
- the character encoding of the streamXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createXMLEventReader(String systemId, InputStream stream) throws XMLStreamException
systemId
- the system ID of the streamstream
- the InputStream to read fromXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter) throws XMLStreamException
reader
- the reader to filterfilter
- the filter to apply to the readerXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter) throws XMLStreamException
reader
- the event reader to wrapfilter
- the filter to apply to the event readerXMLEventReader
XMLStreamException
- if an error occurspublic abstract XMLResolver getXMLResolver()
XMLResolver
public abstract void setXMLResolver(XMLResolver resolver)
resolver
- the resolver to use to resolve referencespublic abstract XMLReporter getXMLReporter()
XMLReporter
public abstract void setXMLReporter(XMLReporter reporter)
reporter
- the resolver to use to report non fatal errorspublic abstract void setProperty(String name, Object value) throws IllegalArgumentException
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
name
- The name of the property (may not be null)IllegalArgumentException
- if the property is not supportedpublic abstract boolean isPropertySupported(String name)
name
- The name of the property (may not be null)public abstract void setEventAllocator(XMLEventAllocator allocator)
allocator
- the user defined allocatorpublic abstract XMLEventAllocator getEventAllocator()
XMLEventAllocator
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/stream/XMLInputFactory.html