XMLInputFactory (Java Platform SE 6) (original) (raw)

javax.xml.stream

Class XMLInputFactory

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

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.

Since:

1.6

See Also:

XMLOutputFactory, XMLEventReader, XMLStreamReader, EventFilter, XMLReporter, XMLResolver, XMLEventAllocator

IS_NAMESPACE_AWARE

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

See Also:

Constant Field Values

IS_VALIDATING

public static final String IS_VALIDATING

The property used to turn on/off implementation specific validation

See Also:

Constant Field Values

IS_COALESCING

public static final String IS_COALESCING

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

See Also:

Constant Field Values

IS_REPLACING_ENTITY_REFERENCES

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

See Also:

Constant Field Values

IS_SUPPORTING_EXTERNAL_ENTITIES

public static final String IS_SUPPORTING_EXTERNAL_ENTITIES

The property that requires the parser to resolve external parsed entities

See Also:

Constant Field Values

SUPPORT_DTD

public static final String SUPPORT_DTD

The property that requires the parser to support DTDs

See Also:

Constant Field Values

REPORTER

public static final String REPORTER

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

See Also:

Constant Field Values

RESOLVER

public static final String RESOLVER

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

See Also:

Constant Field Values

ALLOCATOR

public static final String ALLOCATOR

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

See Also:

Constant Field Values

XMLInputFactory

protected XMLInputFactory()

newInstance

public static XMLInputFactory newInstance() throws FactoryConfigurationError

Create a new instance of the factory.

Throws:

[FactoryConfigurationError](../../../javax/xml/stream/FactoryConfigurationError.html "class in javax.xml.stream") - if an instance of this factory cannot be loaded

newFactory

public 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: 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](../../../javax/xml/stream/FactoryConfigurationError.html "class in javax.xml.stream") - if an instance of this factory cannot be loaded

newInstance

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)](../../../javax/xml/stream/XMLInputFactory.html#newFactory%28java.lang.String, java.lang.ClassLoader%29) 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](../../../javax/xml/stream/FactoryConfigurationError.html "class in javax.xml.stream") - 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. 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](../../../javax/xml/stream/FactoryConfigurationError.html "class in javax.xml.stream") - if an instance of this factory cannot be loaded

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Reader reader) throws XMLStreamException

Create a new XMLStreamReader from a reader

Parameters:

reader - the XML data to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Source source) throws XMLStreamException

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

Parameters:

source - the source to read from

Throws:

[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang") - if this method is not supported by this XMLInputFactory

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(InputStream stream) throws XMLStreamException

Create a new XMLStreamReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 from

encoding - the character encoding of the stream

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 stream

stream - the InputStream to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 stream

reader - the InputStream to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Reader reader) throws XMLStreamException

Create a new XMLEventReader from a reader

Parameters:

reader - the XML data to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 input

reader - the XML data to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Source source) throws XMLStreamException

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

Parameters:

source - the source to read from

Throws:

[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang") - if this method is not supported by this XMLInputFactory

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(InputStream stream) throws XMLStreamException

Create a new XMLEventReader from a java.io.InputStream

Parameters:

stream - the InputStream to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 from

encoding - the character encoding of the stream

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 stream

stream - the InputStream to read from

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 filter

filter - the filter to apply to the reader

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

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 wrap

filter - the filter to apply to the event reader

Throws:

[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")

getXMLResolver

public abstract XMLResolver getXMLResolver()

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

setXMLResolver

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

getXMLReporter

public abstract XMLReporter getXMLReporter()

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

setXMLReporter

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

setProperty

public 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.

Parameters:

name - The name of the property (may not be null)

value - The value of the property

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if the property is not supported

getProperty

public abstract Object getProperty(String name) throws IllegalArgumentException

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](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if the property is not supported

isPropertySupported

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

setEventAllocator

public abstract void setEventAllocator(XMLEventAllocator allocator)

Set a user defined event allocator for events

Parameters:

allocator - the user defined allocator

getEventAllocator

public abstract XMLEventAllocator getEventAllocator()

Gets the allocator used by streams created with this factory

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.