StAX

Streaming API for XML (StAX) is an application programming interface (API) to read and write XML documents in the Java programming language.

Traditionally, XML APIs are either:
* tree based - the entire document is read into memory as a tree structure for random access by the calling application
* event based - the application registers to receive events as entities are encountered within the source document. Both have advantages; the former (for example, DOM) allows for random access to the document, the latter (e.g. SAX) requires a small memory footprint and is typically much faster.

These two access metaphors can be thought of as polar opposites. A tree based API allows unlimited, random, access and manipulation, while an event based API is a 'one shot' pass through the source document.

StAX was designed as a median between these two opposites. In the StAX metaphor, the programmatic entry point is a cursor that represents a point within the document. The application moves the cursor forward - 'pulling' the information from the parser as it needs. This is different from an event based API - such as SAX - which 'pushes' data to the application - requiring the application to maintain state between events as necessary to keep track of location within the document.

Origins

StAX has its roots in a number of incompatible pull APIs for XML, most notably XMLPULL, the authors of which (Stefan Haustein and Aleksandr Slominski) collaborated with, amongst others BEA Systems, Oracle, Sun, [http://www.breezefactor.com/ Breeze Factor] and James Clark.

Examples

From JSR-173 Specification• Final, V1.0 (used under fair use).

Quote::The following Java API shows the main methods for reading XML in the cursor approach. // Java public interface XMLStreamReader { public int next() throws XMLStreamException; public boolean hasNext() throws XMLStreamException; public String getText(); public String getLocalName(); public String getNamespaceURI(); // ...othermethodsnotshown } :The writing side of the API has methods that correspond to the reading side for “StartElement” and “EndElement” event types. // Java public interface XMLStreamWriter { public void writeStartElement(String localName) throws XMLStreamException; public void writeEndElement() throws XMLStreamException; public void writeCharacters(String text) throws XMLStreamException; // ...othermethodsnotshown } :5.3.1 XMLStreamReader :This example illustrates how to instantiate an input factory, create a reader and iterate over the elements of an XML document. XMLInputFactory f = XMLInputFactory.newInstance(); XMLStreamReader r = f.createXMLStreamReader(... ); while (r.hasNext()) { r.next(); }

Implementations

* http://stax.codehaus.org/ Reference Implementation
* [http://woodstox.codehaus.org Woodstox] Open source StAX implementation
* https://sjsxp.dev.java.net is Sun's Stax implementation

Applications

* The video game FreeCol uses the StAX API and the Woodstox implementation as the XML parser for its game data.

See also

Competing and complementary ways to process XML in Java (ordered loosely based on initial date of introduction):
* DOM Document Object Model is the first standardized, language/platform-independent tree-based xml processing model. (note: there are also alternate Java tree models like JDOM, Dom4j, XOM).
* SAX The standard "XML push" API
* JAXB Java XML Binding API: works on top of another parser (usually streaming parser), binds contained data to/from Java objects.
* Javolution provides a real-time StAX-like [http://www.javolution.org/api/javolution/xml/stream/package-summary.html implementation] which does not force object creation (e.g. String) and has smaller effect on memory footprint/garbage collection (Note: to reduce object creation, most StAX implementations maintain lookup tables to retrieve and reuse frequently used String objects).

External links

* [http://www.xml.com/pub/a/2003/09/17/stax.html Introduction to StAX] XML.com, Harold, Elliotte Rusty
* [http://www.vogella.de/articles/JavaXML/article.html Java Streaming API for XML (Stax) - Tutorial]
* [http://jcp.org/en/jsr/detail?id=173 JSR (#173)] :Download JSR specification document as a pdf here: [http://ftpna2.bea.com/pub/downloads/jsr173_1.0.pdf download now]
* [http://www.extreme.indiana.edu/~aslom/xmlpull/ www.extreme.indiana.edu/~aslom/xmlpull/] Articles and resources from Aleksander Slominski.
** [http://www.extreme.indiana.edu/~aslom/xmlpull/patterns.html ~aslom/xmlpull/patterns.html] Article on XML Pull (and StAX) design patterns (recommended).
* [http://www.xmlpull.org/ XMLPull.org]
* [http://www.devx.com/Java/Article/30298/0 StAX and Sax comparison.]
* [http://www.javarants.com/C1464297901/E20060501083853/index.html Using StAX with JAXB for efficiency]
* [http://www.devx.com/tips/Tip/30772 StAX and Java eg. from DevX.com]
* [http://stax-utils.dev.java.net/ StAX-Utils] Provides a set of utility classes that make it easy for developers to integrate StAX into their existing XML processing applications.
** StAX-Utils includes classes to provide XML file indenting and formatting.
* [http://staxmate.codehaus.org/ StaxMate] is a light-weight framework that builds on top of Stax API and provides more convenient nested/filtered cursor for reading xml, and nested outputters for writing xml.