Module java.xml

# Package javax.xml.stream

package javax.xml.stream

Defines interfaces and classes for the Streaming API for XML (StAX).

StAX provides two basic functions: the cursor API allowing users to read and write XML efficiently, and the event iterator API promoting ease of use that is event based, easy to extend and pipeline. The event iterator API is intended to layer on top of the cursor API.

The cursor API defines two interfaces: `XMLStreamReader` and `XMLStreamWriter`, while the event iterator API defines: `XMLEventReader` and `XMLEventWriter`.

StAX supports plugability with `XMLInputFactory` and `XMLOutputFactory` that define how an implementation is located through a process as described in the `newFactory` methods.

Since:
  1.6

Related Packages
Package
Description
javax.xml
Defines constants for XML processing.
javax.xml.stream.events
Defines event interfaces for the Streaming API for XML (StAX).
javax.xml.stream.util
Provides utility classes for the Streaming API for XML (StAX).
Class
Description
EventFilter
This interface declares a simple filter interface that one can create to filter XMLEventReaders
FactoryConfigurationError
An error class for reporting factory configuration errors.
Location
Provides information on the location of an event.
StreamFilter
This interface declares a simple filter interface that one can create to filter XMLStreamReaders
XMLEventFactory
This interface defines a utility class for creating instances of XMLEvents
XMLEventReader
This is the top level interface for parsing XML Events.
XMLEventWriter
This is the top level interface for writing XML documents.
XMLInputFactory
Defines an abstract implementation of a factory for getting streams.
XMLOutputFactory
Defines an abstract implementation of a factory for getting XMLEventWriters and XMLStreamWriters.
XMLReporter
This interface is used to report non-fatal errors.
XMLResolver
This interface is used to resolve resources during an XML parse.
XMLStreamConstants
This interface declares the constants used in this API.
XMLStreamException
The base exception for unexpected processing errors.
XMLStreamReader
The XMLStreamReader interface allows forward, read-only access to XML.
XMLStreamWriter
The XMLStreamWriter interface specifies how to write XML.