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 |
- Since:
- 1.6
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The property used to set/get the implementation of the allocatorstatic final String
The property that requires the parser to coalesce adjacent character data sectionsstatic final String
The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supportedstatic final String
Requires the parser to replace internal entity references with their replacement text and report them as charactersstatic final String
The property that requires the parser to resolve external parsed entitiesstatic final String
The property used to turn on/off implementation specific validationstatic final String
The property used to set/get the implementation of the XMLReporter interfacestatic final String
The property used to set/get the implementation of the XMLResolverstatic final String
The property that requires the parser to support DTDs -
Constructor Summary
ModifierConstructorDescriptionprotected
Protected constructor to prevent instantiation. -
Method Summary
Modifier and TypeMethodDescriptionabstract XMLEventReader
createFilteredReader
(XMLEventReader reader, EventFilter filter) Create a filtered event reader that wraps the filter around the event readerabstract XMLStreamReader
createFilteredReader
(XMLStreamReader reader, StreamFilter filter) Create a filtered reader that wraps the filter around the readerabstract XMLEventReader
createXMLEventReader
(InputStream stream) Create a new XMLEventReader from a java.io.InputStreamabstract XMLEventReader
createXMLEventReader
(InputStream stream, String encoding) Create a new XMLEventReader from a java.io.InputStreamabstract XMLEventReader
createXMLEventReader
(Reader reader) Create a new XMLEventReader from a reader.abstract XMLEventReader
createXMLEventReader
(String systemId, InputStream stream) Create a new XMLEventReader from a java.io.InputStreamabstract XMLEventReader
createXMLEventReader
(String systemId, Reader reader) Create a new XMLEventReader from a reader.abstract XMLEventReader
createXMLEventReader
(XMLStreamReader reader) Create a new XMLEventReader from an XMLStreamReader.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
(InputStream stream, String encoding) 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, InputStream stream) Create a new XMLStreamReader from a java.io.InputStream.abstract XMLStreamReader
createXMLStreamReader
(String systemId, Reader reader) Create a new XMLStreamReader from a java.io.InputStream.abstract XMLStreamReader
createXMLStreamReader
(Source source) Create a new XMLStreamReader from a JAXP source.abstract XMLEventAllocator
Gets the allocator used by streams created with this factoryabstract Object
getProperty
(String name) Get the value of a feature/property from the underlying implementationabstract XMLReporter
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.abstract XMLResolver
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
Creates a new instance of theXMLInputFactory
builtin system-default implementation.static XMLInputFactory
Creates a new instance of the factory.static XMLInputFactory
newFactory
(String factoryId, ClassLoader classLoader) Create a new instance of the factory.static XMLInputFactory
Creates a new instance of the factory in exactly the same manner as thenewFactory()
method.static XMLInputFactory
newInstance
(String factoryId, ClassLoader classLoader) Deprecated.This method has been deprecated to maintain API consistency.abstract void
setEventAllocator
(XMLEventAllocator allocator) Set a user defined event allocator for eventsabstract 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.
-
Field Details
-
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- See Also:
-
IS_VALIDATING
The property used to turn on/off implementation specific validation- See Also:
-
IS_COALESCING
The property that requires the parser to coalesce adjacent character data sections- See Also:
-
IS_REPLACING_ENTITY_REFERENCES
Requires the parser to replace internal entity references with their replacement text and report them as characters- See Also:
-
IS_SUPPORTING_EXTERNAL_ENTITIES
The property that requires the parser to resolve external parsed entities- See Also:
-
SUPPORT_DTD
The property that requires the parser to support DTDs- See Also:
-
REPORTER
The property used to set/get the implementation of the XMLReporter interface- See Also:
-
RESOLVER
The property used to set/get the implementation of the XMLResolver- See Also:
-
ALLOCATOR
The property used to set/get the implementation of the allocator- See Also:
-
-
Constructor Details
-
XMLInputFactory
protected XMLInputFactory()Protected constructor to prevent instantiation. UsenewFactory()
instead.
-
-
Method Details
-
newDefaultFactory
Creates a new instance of theXMLInputFactory
builtin system-default implementation.- Returns:
- A new instance of the
XMLInputFactory
builtin system-default implementation. - Since:
- 9
-
newInstance
Creates a new instance of the factory in exactly the same manner as thenewFactory()
method.- Returns:
- an instance of the
XMLInputFactory
- Throws:
FactoryConfigurationError
- if an instance of this factory cannot be loaded
-
newFactory
Creates a new instance of the factory. This method uses the JAXP Lookup Mechanism to determine theXMLInputFactory
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.- Returns:
- an instance of the
XMLInputFactory
- Throws:
FactoryConfigurationError
- in case of service configuration error or if the implementation is not available or cannot be instantiated.
-
newInstance
@Deprecated(since="1.7") 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 replacementnewFactory(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 nameclassLoader
- classLoader to use- Returns:
- the factory implementation
- Throws:
FactoryConfigurationError
- if an instance of this factory cannot be loaded
-
newFactory
public 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:
-
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 propertyfactoryId
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 theServiceLoader
class, to attempt to locate and load an implementation of the service using the specifiedClassLoader
. IfclassLoader
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.- API Note:
- The parameter factoryId defined here is inconsistent with that of other JAXP factories where the first parameter is fully qualified factory class name that provides implementation of the factory.
- Parameters:
factoryId
- Name of the factory to find, same as a property nameclassLoader
- classLoader to use- Returns:
- the factory implementation
- Throws:
FactoryConfigurationError
- 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 loaded
-
-
createXMLStreamReader
Create a new XMLStreamReader from a reader.- Parameters:
reader
- the XML data to read from- Returns:
- an instance of the
XMLStreamReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLStreamReader
Create a new XMLStreamReader from a JAXP source. This method is optional.- Parameters:
source
- the source to read from- Returns:
- an instance of the
XMLStreamReader
- Throws:
UnsupportedOperationException
- if this method is not supported by this XMLInputFactoryXMLStreamException
- if an error occurs
-
createXMLStreamReader
Create a new XMLStreamReader from a java.io.InputStream.- Parameters:
stream
- the InputStream to read from- Returns:
- an instance of the
XMLStreamReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLStreamReader
public abstract XMLStreamReader createXMLStreamReader(InputStream stream, String encoding) throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream.- Parameters:
stream
- the InputStream to read fromencoding
- the character encoding of the stream- Returns:
- an instance of the
XMLStreamReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLStreamReader
public abstract XMLStreamReader createXMLStreamReader(String systemId, InputStream stream) throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream.- Parameters:
systemId
- the system ID of the streamstream
- the InputStream to read from- Returns:
- an instance of the
XMLStreamReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLStreamReader
public abstract XMLStreamReader createXMLStreamReader(String systemId, Reader reader) throws XMLStreamException Create a new XMLStreamReader from a java.io.InputStream.- Parameters:
systemId
- the system ID of the streamreader
- the InputStream to read from- Returns:
- an instance of the
XMLStreamReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
Create a new XMLEventReader from a reader.- Parameters:
reader
- the XML data to read from- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
public abstract XMLEventReader createXMLEventReader(String systemId, Reader reader) throws XMLStreamException Create a new XMLEventReader from a reader.- Parameters:
systemId
- the system ID of the inputreader
- the XML data to read from- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
public 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.- Parameters:
reader
- the XMLStreamReader to read from (may not be modified)- Returns:
- a new XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
Create a new XMLEventReader from a JAXP source. Support of this method is optional.- Parameters:
source
- the source to read from- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occursUnsupportedOperationException
- if this method is not supported by this XMLInputFactory
-
createXMLEventReader
Create a new XMLEventReader from a java.io.InputStream- Parameters:
stream
- the InputStream to read from- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
public abstract XMLEventReader createXMLEventReader(InputStream stream, String encoding) throws XMLStreamException Create a new XMLEventReader from a java.io.InputStream- Parameters:
stream
- the InputStream to read fromencoding
- the character encoding of the stream- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createXMLEventReader
public abstract XMLEventReader createXMLEventReader(String systemId, InputStream stream) throws XMLStreamException Create a new XMLEventReader from a java.io.InputStream- Parameters:
systemId
- the system ID of the streamstream
- the InputStream to read from- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createFilteredReader
public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter) throws XMLStreamException Create a filtered reader that wraps the filter around the reader- Parameters:
reader
- the reader to filterfilter
- the filter to apply to the reader- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
createFilteredReader
public abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter) throws XMLStreamException Create a filtered event reader that wraps the filter around the event reader- Parameters:
reader
- the event reader to wrapfilter
- the filter to apply to the event reader- Returns:
- an instance of the
XMLEventReader
- Throws:
XMLStreamException
- if an error occurs
-
getXMLResolver
The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.- Returns:
- an instance of the
XMLResolver
-
setXMLResolver
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
-
getXMLReporter
The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.- Returns:
- an instance of the
XMLReporter
-
setXMLReporter
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
-
setProperty
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 theXMLStreamReader.next()
orXMLEventReader.nextEvent()
method.
- 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
-
-
getProperty
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
-
isPropertySupported
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
-
setEventAllocator
Set a user defined event allocator for events- Parameters:
allocator
- the user defined allocator
-
getEventAllocator
Gets the allocator used by streams created with this factory- Returns:
- an instance of the
XMLEventAllocator
-