Class MXParserFactory

java.lang.Object

javax.xml.stream.XMLInputFactory

com.bea.xml.stream.MXParserFactory

public class MXParserFactory
extends XMLInputFactory

Field Summary

Fields inherited from class XMLInputFactory

ALLOCATOR, IS_COALESCING, IS_NAMESPACE_AWARE, IS_REPLACING_ENTITY_REFERENCES, IS_SUPPORTING_EXTERNAL_ENTITIES, IS_VALIDATING, REPORTER, RESOLVER, SUPPORT_DTD

Constructor Summary

Constructors

Constructor	Description
MXParserFactory()

Method Summary

Modifier and Type	Method	Description
XMLEventReader	createFilteredReader(XMLEventReader reader, EventFilter filter)	Create a filtered event reader that wraps the filter around the event reader
XMLStreamReader	createFilteredReader(XMLStreamReader reader, StreamFilter filter)	Create a filtered reader that wraps the filter around the reader
XMLEventReader	createXMLEventReader(InputStream stream)	Create a new XMLEventReader from an input stream
XMLEventReader	createXMLEventReader(InputStream stream, String encoding)	Create a new XMLEventReader from an input stream
XMLEventReader	createXMLEventReader(Reader reader)	Create a new XMLEventReader from a reader
XMLEventReader	createXMLEventReader(String systemId, InputStream stream)	Create a new XMLEventReader from a java.io.InputStream
XMLEventReader	createXMLEventReader(String systemId, Reader reader)	Create a new XMLEventReader from a reader
XMLEventReader	createXMLEventReader(XMLStreamReader reader)	Create a new XMLEventReader from an XMLStreamReader
XMLEventReader	createXMLEventReader(Source source)	Create a new XMLEventReader from a JAXP source
XMLStreamReader	createXMLStreamReader(InputStream stream)	Create a new XMLStreamReader from a java.io.stream
XMLStreamReader	createXMLStreamReader(InputStream stream, String encoding)	Create a new XMLStreamReader from a java.io.stream
XMLStreamReader	createXMLStreamReader(Reader in)	Create a new XMLStreamReader from a reader
XMLStreamReader	createXMLStreamReader(String systemId, InputStream stream)	Create a new XMLStreamReader from a java.io.InputStream
XMLStreamReader	createXMLStreamReader(String systemId, Reader reader)	Create a new XMLStreamReader from a java.io.InputStream
XMLStreamReader	createXMLStreamReader(Source source)	Create a new XMLStreamReader from a JAXP source.
XMLEventAllocator	getEventAllocator()	Gets the allocator used by streams created with this factory
Object	getProperty(String name)	Get the value of a feature/property from the underlying implementation
XMLReporter	getXMLReporter()	The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
XMLResolver	getXMLResolver()	The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
boolean	isCoalescing()	Indicates whether or not the factory is configured to produced streams that coalesce adjacent text nodes.
boolean	isPropertySupported(String name)	Query the set of properties that this factory supports.
static XMLInputFactory	newInstance()
void	setCoalescing(boolean coalescing)	Specifies that the stream produced by this code will append all adjacent text nodes.
void	setEventAllocator(XMLEventAllocator allocator)	Set a user defined event allocator for events
void	setProperty(String name, Object value)	Allows the user to set specific feature/property on the underlying implementation.
void	setXMLReporter(XMLReporter reporter)	The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
void	setXMLResolver(XMLResolver resolver)	The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

Methods inherited from class XMLInputFactory

newInstance

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MXParserFactory

public MXParserFactory()

Method Details

newInstance

public static XMLInputFactory newInstance()

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(Source source)
                                      throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

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

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

source - the source to read from

Throws:

XMLStreamException

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(InputStream stream)
                                      throws XMLStreamException

Create a new XMLStreamReader from a java.io.stream

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(InputStream stream,
 String encoding)
                                      throws XMLStreamException

Create a new XMLStreamReader from a java.io.stream

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

stream - the InputStream to read from

encoding - the character encoding of the stream

Throws:

XMLStreamException

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(String systemId,
 InputStream stream)
                                      throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

Create a new XMLStreamReader from a java.io.InputStream

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

systemId - the system ID of the stream

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(String systemId,
 Reader reader)
                                      throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

Create a new XMLStreamReader from a java.io.InputStream

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

systemId - the system ID of the stream

reader - the InputStream to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(String systemId,
 Reader reader)
                                    throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

Create a new XMLEventReader from a reader

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

systemId - the system ID of the input

reader - the XML data to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(String systemId,
 InputStream stream)
                                    throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

Create a new XMLEventReader from a java.io.InputStream

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

systemId - the system ID of the stream

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(Reader reader)
                                    throws XMLStreamException

Create a new XMLEventReader from a reader

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

reader - the XML data to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(XMLStreamReader reader)
                                    throws XMLStreamException

Create a new XMLEventReader from an XMLStreamReader

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

reader - the XMLEventReader to read from

Returns:

a new XMLEventReader

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(Source source)
                                    throws XMLStreamException

Create a new XMLEventReader from a JAXP source

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

source - the source to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(InputStream stream)
                                    throws XMLStreamException

Create a new XMLEventReader from an input stream

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

stream - the InputStream to read from

Throws:

XMLStreamException

createXMLEventReader

public XMLEventReader createXMLEventReader(InputStream stream,
 String encoding)
                                    throws XMLStreamException

Create a new XMLEventReader from an input stream

Specified by:

createXMLEventReader in class XMLInputFactory

Parameters:

stream - the InputStream to read from

encoding - the character encoding of the stream

Throws:

XMLStreamException

getXMLResolver

public XMLResolver getXMLResolver()

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

Specified by:

getXMLResolver in class XMLInputFactory

setXMLResolver

public void setXMLResolver(XMLResolver resolver)

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

Specified by:

setXMLResolver in class XMLInputFactory

Parameters:

resolver - the resolver to use to resolve references

createFilteredReader

public XMLStreamReader createFilteredReader(XMLStreamReader reader,
 StreamFilter filter)
                                     throws XMLStreamException

Create a filtered reader that wraps the filter around the reader

Specified by:

createFilteredReader in class XMLInputFactory

Parameters:

reader - the reader to filter

filter - the filter to apply to the reader

Throws:

XMLStreamException

createFilteredReader

public XMLEventReader createFilteredReader(XMLEventReader reader,
 EventFilter filter)
                                    throws XMLStreamException

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

Specified by:

createFilteredReader in class XMLInputFactory

Parameters:

reader - the event reader to wrap

filter - the filter to apply to the event reader

Throws:

XMLStreamException

getXMLReporter

public XMLReporter getXMLReporter()

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

Specified by:

getXMLReporter in class XMLInputFactory

setXMLReporter

public void setXMLReporter(XMLReporter reporter)

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

Specified by:

setXMLReporter in class XMLInputFactory

Parameters:

reporter - the resolver to use to report non fatal errors

setEventAllocator

public void setEventAllocator(XMLEventAllocator allocator)

Set a user defined event allocator for events

Specified by:

setEventAllocator in class XMLInputFactory

Parameters:

allocator - the user defined allocator

getEventAllocator

public XMLEventAllocator getEventAllocator()

Gets the allocator used by streams created with this factory

Specified by:

getEventAllocator in class XMLInputFactory

setCoalescing

public void setCoalescing(boolean coalescing)

Specifies that the stream produced by this code will append all adjacent text nodes.

isCoalescing

public boolean isCoalescing()

Indicates whether or not the factory is configured to produced streams that coalesce adjacent text nodes.

setProperty

public void setProperty(String name,
 Object value)
                 throws IllegalArgumentException

Description copied from class: javax.xml.stream.XMLInputFactory

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.

Specified by:

setProperty in class XMLInputFactory

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

public Object getProperty(String name)
                   throws IllegalArgumentException

Description copied from class: javax.xml.stream.XMLInputFactory

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

Specified by:

getProperty in class XMLInputFactory

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

createXMLStreamReader

public XMLStreamReader createXMLStreamReader(Reader in)
                                      throws XMLStreamException

Description copied from class: javax.xml.stream.XMLInputFactory

Create a new XMLStreamReader from a reader

Specified by:

createXMLStreamReader in class XMLInputFactory

Parameters:

in - the XML data to read from

Throws:

XMLStreamException

isPropertySupported

public boolean isPropertySupported(String name)

Description copied from class: javax.xml.stream.XMLInputFactory

Query the set of properties that this factory supports.

Specified by:

isPropertySupported in class XMLInputFactory

Parameters:

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

Returns:

true if the property is supported and false otherwise