public abstract class

XMLInputFactory

extends Object
java.lang.Object
   ↳ javax.xml.stream.XMLInputFactory

Class Overview

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.isValidatingTurns on/off implementation specific DTD validationBooleanFalseNo
javax.xml.stream.isNamespaceAwareTurns on/off namespace processing for XML 1.0 supportBooleanTrueTrue (required) / False (optional)
javax.xml.stream.isCoalescingRequires the processor to coalesce adjacent character dataBooleanFalseYes
javax.xml.stream.isReplacingEntityReferencesreplace internal entity references with their replacement text and report them as charactersBooleanTrueYes
javax.xml.stream.isSupportingExternalEntitiesResolve external parsed entitiesBooleanUnspecifiedYes
javax.xml.stream.supportDTDUse this property to request processors that do not support DTDsBooleanTrueYes
javax.xml.stream.reportersets/gets the impl of the XMLReporter javax.xml.stream.XMLReporterNullYes
javax.xml.stream.resolversets/gets the impl of the XMLResolver interfacejavax.xml.stream.XMLResolverNullYes
javax.xml.stream.allocatorsets/gets the impl of the XMLEventAllocator interfacejavax.xml.stream.util.XMLEventAllocatorNullYes

Summary

Constants
String ALLOCATOR The property used to set/get the implementation of the allocator
String IS_COALESCING The property that requires the parser to coalesce adjacent character data sections
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
String IS_REPLACING_ENTITY_REFERENCES Requires the parser to replace internal entity references with their replacement text and report them as characters
String IS_SUPPORTING_EXTERNAL_ENTITIES The property that requires the parser to resolve external parsed entities
String IS_VALIDATING The property used to turn on/off implementation specific validation
String REPORTER The property used to set/get the implementation of the XMLReporter interface
String RESOLVER The property used to set/get the implementation of the XMLResolver
String SUPPORT_DTD The property that requires the parser to support DTDs
Protected Constructors
XMLInputFactory()
Public Methods
abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)
Create a filtered event reader that wraps the filter around the event reader
abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)
Create a filtered reader that wraps the filter around the reader
abstract XMLEventReader createXMLEventReader(String systemId, InputStream stream)
Create a new XMLEventReader from a java.io.InputStream
abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
Create a new XMLEventReader from an XMLStreamReader.
abstract XMLEventReader createXMLEventReader(InputStream stream, String encoding)
Create a new XMLEventReader from a java.io.InputStream
abstract XMLEventReader createXMLEventReader(Reader reader)
Create a new XMLEventReader from a reader
abstract XMLEventReader createXMLEventReader(InputStream stream)
Create a new XMLEventReader from a java.io.InputStream
abstract XMLEventReader createXMLEventReader(String systemId, Reader reader)
Create a new XMLEventReader from a reader
abstract XMLEventReader createXMLEventReader(Source source)
Create a new XMLEventReader from a JAXP source.
abstract XMLStreamReader createXMLStreamReader(InputStream stream)
Create a new XMLStreamReader from a java.io.InputStream
abstract XMLStreamReader createXMLStreamReader(Reader reader)
Create a new XMLStreamReader from a reader
abstract XMLStreamReader createXMLStreamReader(String systemId, Reader reader)
Create a new XMLStreamReader from a java.io.InputStream
abstract XMLStreamReader createXMLStreamReader(String systemId, InputStream stream)
Create a new XMLStreamReader from a java.io.InputStream
abstract XMLStreamReader createXMLStreamReader(Source source)
Create a new XMLStreamReader from a JAXP source.
abstract XMLStreamReader createXMLStreamReader(InputStream stream, String encoding)
Create a new XMLStreamReader from a java.io.InputStream
abstract XMLEventAllocator getEventAllocator()
Gets the allocator used by streams created with this factory
abstract Object getProperty(String name)
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(String name)
Query the set of properties that this factory supports.
static XMLInputFactory newFactory()
Create a new instance of the factory.
static XMLInputFactory newFactory(String factoryId, ClassLoader classLoader)
Create a new instance of the factory.
static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader)
This method is 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.
static XMLInputFactory newInstance()
Create a new instance of the factory.
abstract void setEventAllocator(XMLEventAllocator allocator)
Set a user defined event allocator for events
abstract void setProperty(String name, Object value)
Allows the user to set specific feature/property on the underlying implementation.
abstract void setXMLReporter(XMLReporter reporter)
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
abstract void setXMLResolver(XMLResolver resolver)
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ALLOCATOR

The property used to set/get the implementation of the allocator

Constant Value: "javax.xml.stream.allocator"

public static final String IS_COALESCING

The property that requires the parser to coalesce adjacent character data sections

Constant Value: "javax.xml.stream.isCoalescing"

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

Constant Value: "javax.xml.stream.isNamespaceAware"

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

Constant Value: "javax.xml.stream.isReplacingEntityReferences"

public static final String IS_SUPPORTING_EXTERNAL_ENTITIES

The property that requires the parser to resolve external parsed entities

Constant Value: "javax.xml.stream.isSupportingExternalEntities"

public static final String IS_VALIDATING

The property used to turn on/off implementation specific validation

Constant Value: "javax.xml.stream.isValidating"

public static final String REPORTER

The property used to set/get the implementation of the XMLReporter interface

Constant Value: "javax.xml.stream.reporter"

public static final String RESOLVER

The property used to set/get the implementation of the XMLResolver

Constant Value: "javax.xml.stream.resolver"

public static final String SUPPORT_DTD

The property that requires the parser to support DTDs

Constant Value: "javax.xml.stream.supportDTD"

Protected Constructors

protected XMLInputFactory ()

Public Methods

public abstract XMLEventReader createFilteredReader (XMLEventReader reader, EventFilter filter)

Create a filtered event reader that wraps the filter around the event reader

Parameters
reader the event reader to wrap
filter the filter to apply to the event reader

public abstract XMLStreamReader createFilteredReader (XMLStreamReader reader, StreamFilter filter)

Create a filtered reader that wraps the filter around the reader

Parameters
reader the reader to filter
filter the filter to apply to the reader

public abstract XMLEventReader createXMLEventReader (String systemId, InputStream stream)

Create a new XMLEventReader from a java.io.InputStream

Parameters
systemId the system ID of the stream
stream the InputStream to read from

public abstract XMLEventReader createXMLEventReader (XMLStreamReader reader)

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.

Parameters
reader the XMLStreamReader to read from (may not be modified)
Returns
  • a new XMLEventReader

public abstract XMLEventReader createXMLEventReader (InputStream stream, String encoding)

Create a new XMLEventReader from a java.io.InputStream

Parameters
stream the InputStream to read from
encoding the character encoding of the stream

public abstract XMLEventReader createXMLEventReader (Reader reader)

Create a new XMLEventReader from a reader

Parameters
reader the XML data to read from

public abstract XMLEventReader createXMLEventReader (InputStream stream)

Create a new XMLEventReader from a java.io.InputStream

Parameters
stream the InputStream to read from

public abstract XMLEventReader createXMLEventReader (String systemId, Reader reader)

Create a new XMLEventReader from a reader

Parameters
systemId the system ID of the input
reader the XML data to read from

public abstract XMLEventReader createXMLEventReader (Source source)

Create a new XMLEventReader from a JAXP source. Support of this method is optional.

Parameters
source the source to read from
Throws
UnsupportedOperationException if this method is not supported by this XMLInputFactory
XMLStreamException

public abstract XMLStreamReader createXMLStreamReader (InputStream stream)

Create a new XMLStreamReader from a java.io.InputStream

Parameters
stream the InputStream to read from

public abstract XMLStreamReader createXMLStreamReader (Reader reader)

Create a new XMLStreamReader from a reader

Parameters
reader the XML data to read from

public abstract XMLStreamReader createXMLStreamReader (String systemId, Reader reader)

Create a new XMLStreamReader from a java.io.InputStream

Parameters
systemId the system ID of the stream
reader the InputStream to read from

public abstract XMLStreamReader createXMLStreamReader (String systemId, InputStream stream)

Create a new XMLStreamReader from a java.io.InputStream

Parameters
systemId the system ID of the stream
stream the InputStream to read from

public abstract XMLStreamReader createXMLStreamReader (Source source)

Create a new XMLStreamReader from a JAXP source. This method is optional.

Parameters
source the source to read from
Throws
UnsupportedOperationException if this method is not supported by this XMLInputFactory
XMLStreamException

public abstract XMLStreamReader createXMLStreamReader (InputStream stream, String encoding)

Create a new XMLStreamReader from a java.io.InputStream

Parameters
stream the InputStream to read from
encoding the character encoding of the stream

public abstract XMLEventAllocator getEventAllocator ()

Gets the allocator used by streams created with this factory

public abstract Object getProperty (String name)

Get the value of a feature/property from the underlying implementation

Parameters
name The name of the property (may not be null)
Returns
  • The value of the property
Throws
IllegalArgumentException if the property is not supported

public abstract XMLReporter getXMLReporter ()

The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

public abstract XMLResolver getXMLResolver ()

The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

public abstract boolean isPropertySupported (String name)

Query the set of properties that this factory supports.

Parameters
name The name of the property (may not be null)
Returns
  • true if the property is supported and false otherwise

public static XMLInputFactory newFactory ()

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: Use the javax.xml.stream.XMLInputFactory system property. Use the properties file "lib/stax.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.stream.XMLInputFactory in jars available to the runtime. Platform default XMLInputFactory instance. 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.

Throws
FactoryConfigurationError if an instance of this factory cannot be loaded

public static XMLInputFactory newFactory (String factoryId, ClassLoader classLoader)

Create a new instance of the factory. If the classLoader argument is null, then the ContextClassLoader is used. 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.

Parameters
factoryId Name of the factory to find, same as a property name
classLoader classLoader to use
Returns
  • the factory implementation
Throws
FactoryConfigurationError if an instance of this factory cannot be loaded

public static XMLInputFactory newInstance (String factoryId, ClassLoader classLoader)

This method is 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

Parameters
factoryId Name of the factory to find, same as a property name
classLoader classLoader to use
Returns
  • the factory implementation
Throws
FactoryConfigurationError if an instance of this factory cannot be loaded

public static XMLInputFactory newInstance ()

Create a new instance of the factory.

Throws
FactoryConfigurationError if an instance of this factory cannot be loaded

public abstract void setEventAllocator (XMLEventAllocator allocator)

Set a user defined event allocator for events

Parameters
allocator the user defined allocator

public abstract void setProperty (String name, Object value)

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.

Parameters
name The name of the property (may not be null)
value The value of the property
Throws
IllegalArgumentException if the property is not supported

public abstract void setXMLReporter (XMLReporter reporter)

The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

Parameters
reporter the resolver to use to report non fatal errors

public abstract void setXMLResolver (XMLResolver resolver)

The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

Parameters
resolver the resolver to use to resolve references