StaxMate: Automatic Shifting for Streaming XML Processing
Java HTML Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
release-notes
sample-webapp
src Fix #7 Aug 30, 2014
.gitignore
.travis.yml Added .travis.yml. Feb 27, 2015
LICENSE.txt
README.md
build.xml
pom.xml
run.sh Start moving over StaxMate from codehaus Sep 20, 2012

README.md

StaxMate -- the perfect companion for a Stax processor!

StaxMate is an Open Source helper library (or, mini-framework), written in Java, designed to simplify common tasks for which Stax-based streaming pull parsers are used (and good) for. This simplification, and added convenience is to be achieved without compromising positive performance characteristics of good Stax implementations, such as low memory usage and high processing throughput.

As with Stax API, input and output sides are separate, and distinction may be even more pronounced. However, whereas Stax API has division between "raw" cursor API, and more object-oriented Event API, StaxMate presents only a single level of abstraction, on input and output sides. StaxMate reader-side abstractions are mostly based on Cursor API, but some support for Event API is also planned for interoperability purposes.

Status

Build Status

Stax implementations supported

StaxMate aims to be implementation dependant, so in theory any compliant Stax implementation should be usable. In practice, some implementations may work better than others -- you may want to check out Stax-related email lists for comments on which implementations wor best.

As of version 1.2, following implementations are known to work well enough to pass StaxMate unit tests:

Since the initial development was done against Woodstox Stax processor, Woodstox is probably least likely to have problems with StaxMate. There are also some known issue with SJSXP: specifically, it tends to write unnecessary namespace declarations.

Licensing

StaxMate is licensed under BSD 2

Documentation, downloads

Check project Wiki.

Maven coordinates

Newer versions (2.1.x and above) of StaxMate use following Maven coordinates:

<dependency>
  <groupId>com.fasterxml.staxmate</groupId>
  <artifactId>staxmate</artifactId>
<dependency>

Older versions (1.1 through 2.0) instead use group id of org.codehaus.staxmate.

Authors

Author of StaxMate is Tatu "cowtowncoder" Saloranta, tatu.saloranta@iki.fi

Other people who have participated in development (usually by submitting bug reports and patches) are listed in 'CREDITS' file. They are considered co-authors of StaxMate, and are integral to the quality of the codebase.