javax.xml.stream
Class XMLInputFactory

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

public abstract class XMLInputFactory
extends Object

Factory for creating stream and event readers from various kinds of input source.

Parameters

Name Description Type Default Required
javax.xml.stream.isValidating Controls DTD validation Boolean Boolean.FALSE no
javax.xml.stream.isNamespaceAware Controls namespace processing for XML 1.0 Boolean Boolean.TRUE true is required, false is optional
javax.xml.stream.isCoalescing Controls coalescing (normalization of adjacent character data) Boolean Boolean.FALSE yes
javax.xml.stream.isReplacingEntityReferences Controls replacement of entity references with their replacement text Boolean Boolean.TRUE yes
javax.xml.stream.isSupportingExternalEntities Controls whether to resolve external entities Boolean not specified yes
javax.xml.stream.supportDTD Controls whether to support DTDs Boolean Boolean.TRUE yes
javax.xml.stream.reporter javax.xml.stream.XMLReporter yes
javax.xml.stream.resolver javax.xml.stream.XMLResolver yes
javax.xml.stream.allocator javax.xml.stream.util.XMLEventAllocator yes


Field Summary
static String ALLOCATOR
          Property used to control the event allocator implementation.
static String IS_COALESCING
          Property used to control whether to coalesce adjacent text events.
static String IS_NAMESPACE_AWARE
          Property used to control namespace support.
static String IS_REPLACING_ENTITY_REFERENCES
          Property used to control whether to replace entity references with their replacement text.
static String IS_SUPPORTING_EXTERNAL_ENTITIES
          Property used to control whether to resolve external entities.
static String IS_VALIDATING
          Property used to control DTD validation.
static String REPORTER
          Property used to control the error reporter implementation.
static String RESOLVER
          Property used to control the entity resolver implementation.
static String SUPPORT_DTD
          Property used to indicate whether to support DTDs.
 
Constructor Summary
protected XMLInputFactory()
           
 
Method Summary
abstract  XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)
          Create a new filtered reader.
abstract  XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)
          Create a new filtered reader.
abstract  XMLEventReader createXMLEventReader(InputStream stream)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(InputStream stream, String encoding)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(Reader reader)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(Source source)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(String systemId, InputStream stream)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(String systemId, Reader reader)
          Creates a new event reader.
abstract  XMLEventReader createXMLEventReader(XMLStreamReader reader)
          Creates a new event reader.
abstract  XMLStreamReader createXMLStreamReader(InputStream stream)
          Creates a new stream reader.
abstract  XMLStreamReader createXMLStreamReader(InputStream stream, String encoding)
          Creates a new stream reader.
abstract  XMLStreamReader createXMLStreamReader(Reader reader)
          Creates a new stream reader.
abstract  XMLStreamReader createXMLStreamReader(Source source)
          Creates a new stream reader.
abstract  XMLStreamReader createXMLStreamReader(String systemId, InputStream stream)
          Creates a new stream reader.
abstract  XMLStreamReader createXMLStreamReader(String systemId, Reader reader)
          Creates a new stream reader.
abstract  XMLEventAllocator getEventAllocator()
          Returns the event allocator.
abstract  Object getProperty(String name)
          Returns the implementation-specific property of the given name.
abstract  XMLReporter getXMLReporter()
          Returns the error reporter.
abstract  XMLResolver getXMLResolver()
          Returns the entity resolver.
abstract  boolean isPropertySupported(String name)
          Indicates whether the specified property is supported.
static XMLInputFactory newInstance()
          Creates a new factory instance.
static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader)
          Creates a new factory instance.
abstract  void setEventAllocator(XMLEventAllocator allocator)
          Sets the event allocator.
abstract  void setProperty(String name, Object value)
          Sets the implementation-specific property of the given name.
abstract  void setXMLReporter(XMLReporter reporter)
          Sets the error reporter.
abstract  void setXMLResolver(XMLResolver resolver)
          Sets the entity resolver.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IS_NAMESPACE_AWARE

public static final String IS_NAMESPACE_AWARE
Property used to control namespace support.

See Also:
Constant Field Values

IS_VALIDATING

public static final String IS_VALIDATING
Property used to control DTD validation.

See Also:
Constant Field Values

IS_COALESCING

public static final String IS_COALESCING
Property used to control whether to coalesce adjacent text events.

See Also:
Constant Field Values

IS_REPLACING_ENTITY_REFERENCES

public static final String IS_REPLACING_ENTITY_REFERENCES
Property used to control whether to replace entity references with their replacement text.

See Also:
Constant Field Values

IS_SUPPORTING_EXTERNAL_ENTITIES

public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
Property used to control whether to resolve external entities.

See Also:
Constant Field Values

SUPPORT_DTD

public static final String SUPPORT_DTD
Property used to indicate whether to support DTDs.

See Also:
Constant Field Values

REPORTER

public static final String REPORTER
Property used to control the error reporter implementation.

See Also:
Constant Field Values

RESOLVER

public static final String RESOLVER
Property used to control the entity resolver implementation.

See Also:
Constant Field Values

ALLOCATOR

public static final String ALLOCATOR
Property used to control the event allocator implementation.

See Also:
Constant Field Values
Constructor Detail

XMLInputFactory

protected XMLInputFactory()
Method Detail

newInstance

public static XMLInputFactory newInstance()
                                   throws FactoryConfigurationError
Creates a new factory instance.

Throws:
FactoryConfigurationError
See Also:
newInstance(String,ClassLoader)

newInstance

public static XMLInputFactory newInstance(String factoryId,
                                          ClassLoader classLoader)
                                   throws FactoryConfigurationError
Creates a new factory instance. The implementation class to load is the first found in the following locations:
  1. the javax.xml.stream.XMLInputFactory system property
  2. the above named property value in the $JAVA_HOME/lib/stax.properties file
  3. the class name specified in the META-INF/services/javax.xml.stream.XMLInputFactory system resource
  4. the default factory class

Throws:
FactoryConfigurationError

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Reader reader)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Source source)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(InputStream stream)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(InputStream stream,
                                                      String encoding)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                                      InputStream stream)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                                      Reader reader)
                                               throws XMLStreamException
Creates a new stream reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Reader reader)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(String systemId,
                                                    Reader reader)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Source source)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(InputStream stream)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(InputStream stream,
                                                    String encoding)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(String systemId,
                                                    InputStream stream)
                                             throws XMLStreamException
Creates a new event reader.

Throws:
XMLStreamException

createFilteredReader

public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,
                                                     StreamFilter filter)
                                              throws XMLStreamException
Create a new filtered reader.

Throws:
XMLStreamException

createFilteredReader

public abstract XMLEventReader createFilteredReader(XMLEventReader reader,
                                                    EventFilter filter)
                                             throws XMLStreamException
Create a new filtered reader.

Throws:
XMLStreamException

getXMLResolver

public abstract XMLResolver getXMLResolver()
Returns the entity resolver.


setXMLResolver

public abstract void setXMLResolver(XMLResolver resolver)
Sets the entity resolver.


getXMLReporter

public abstract XMLReporter getXMLReporter()
Returns the error reporter.


setXMLReporter

public abstract void setXMLReporter(XMLReporter reporter)
Sets the error reporter.


setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws IllegalArgumentException
Sets the implementation-specific property of the given name.

Throws:
IllegalArgumentException - if the property is not supported

getProperty

public abstract Object getProperty(String name)
                            throws IllegalArgumentException
Returns the implementation-specific property of the given name.

Throws:
IllegalArgumentException - if the property is not supported

isPropertySupported

public abstract boolean isPropertySupported(String name)
Indicates whether the specified property is supported.


setEventAllocator

public abstract void setEventAllocator(XMLEventAllocator allocator)
Sets the event allocator.


getEventAllocator

public abstract XMLEventAllocator getEventAllocator()
Returns the event allocator.