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.
| Modifier and Type | Interface and Description |
|---|---|
| public interface | EventFilter
This interface declares a simple filter interface that one can create to filter XMLEventReaders |
| public interface | Location
Provides information on the location of an event. |
| public interface | StreamFilter
This interface declares a simple filter interface that one can create to filter XMLStreamReaders |
| public interface | XMLEventReader
This is the top level interface for parsing XML Events. |
| public interface | XMLEventWriter
This is the top level interface for writing XML documents. |
| public interface | XMLReporter
This interface is used to report non-fatal errors. |
| public interface | XMLResolver
This interface is used to resolve resources during an XML parse. |
| public interface | XMLStreamConstants
This interface declares the constants used in this API. |
| public interface | XMLStreamReader
The XMLStreamReader interface allows forward, read-only access to XML. |
| public interface | XMLStreamWriter
The XMLStreamWriter interface specifies how to write XML. |
| Modifier and Type | Class and Description |
|---|---|
| public class | FactoryConfigurationError
An error class for reporting factory configuration errors. |
| pack-priv class | FactoryFinder
Implements pluggable streams. |
| public abstract class | XMLEventFactory
This interface defines a utility class for creating instances of XMLEvents |
| public abstract class | XMLInputFactory
Defines an abstract implementation of a factory for getting streams. |
| public abstract class | XMLOutputFactory
Defines an abstract implementation of a factory for getting XMLEventWriters and XMLStreamWriters. |
| public class | XMLStreamException
The base exception for unexpected processing errors. |