Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fasterxml/woodstox

The gold standard Stax XML API implementation. Now at Github.
https://github.com/fasterxml/woodstox

hacktoberfest stax-api xml xml-parser

Last synced: 3 days ago
JSON representation

The gold standard Stax XML API implementation. Now at Github.

Host: GitHub
URL: https://github.com/fasterxml/woodstox
Owner: FasterXML
License: apache-2.0
Created: 2014-08-01T19:56:59.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-11-27T22:51:19.000Z (2 months ago)
Last Synced: 2025-01-23T04:01:38.448Z (10 days ago)
Topics: hacktoberfest, stax-api, xml, xml-parser
Language: Java
Homepage:
Size: 8.61 MB
Stars: 230
Watchers: 13
Forks: 83
Open Issues: 41
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Overview

The gold standard [Stax](https://en.wikipedia.org/wiki/StAX) XML "pull" API (`javax.xml.stream`) implementation.

Since version 4.0, Woodstox also implements [SAX](https://en.wikipedia.org/wiki/Simple_API_for_XML) API for event-based XML processing.

Most if not all popular Java XML web service frameworks use either Stax or SAX API for XML processing: this means that Woodstox can be used with the most popular Java frameworks.

For longer overview, here are some options for more reading:

* [Parsing large XML files with Woodstox](http://www.softwarepassion.com/parsing-large-xml-files-with-woodstox-library/)

* [Parsing an XML File Using StAX](https://www.baeldung.com/java-stax)

But in general usage follows standard Stax or SAX API usage.

## Status

| Type | Status |

| ---- | ------ |

| Build (CI) | [![Build (github)](https://github.com/FasterXML/woodstox/actions/workflows/main.yml/badge.svg)](https://github.com/FasterXML/woodstox/actions/workflows/main.yml) |

| Artifact |  [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.woodstox/woodstox-core/) |

| OSS Sponsorship | [![Tidelift](https://tidelift.com/badges/package/maven/com.fasterxml.woodstox:woodstox-core)](https://tidelift.com/subscription/pkg/maven-com-fasterxml-woodstox-woodstox-core?utm_source=maven-com-fasterxml-woodstox-woodstox-core&utm_medium=referral&utm_campaign=readme) |

| Javadocs | [![Javadoc](https://javadoc.io/badge/com.fasterxml.woodstox/woodstox-core.svg)](http://www.javadoc.io/doc/com.fasterxml.woodstox/woodstox-core)

| Code coverage (7.x) | [![codecov.io](https://codecov.io/github/FasterXML/woodstox/coverage.svg?branch=master)](https://codecov.io/github/FasterXML/woodstox?branch=master) |

| OpenSSF Score | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/FasterXML/woodstox/badge)](https://securityscorecards.dev/viewer/?uri=github.com/FasterXML/woodstox) |

# Get it!

## Maven

The most common way is to use Maven (or Ivy) to access it from Maven Central repository.

Coordinates for this are:

* Group id: `com.fasterxml.woodstox`

* Artifact id: `woodstox-core`

* Latest published version: 7.0.0 (2024-06-21)

Note that Maven id has changed since Woodstox 4.x but API is still compatible (despite nominal major version upgrade -- major version upgrades in this case were only due to package coordinate changes)

## Requirements

Woodstox 7 and above require Java 8; Woodstox 5 and above require Java 6 (JDK 1.6).

All versions also require Stax API that is included in JDK (since Java 6).

The only other mandatory dependency is [Stax2 API](../../../stax2-api), extended API implemented

by Woodstox and some other Stax implementations (like [Aalto](../../../aalto-xml).

Optional dependency is [Multi-Schema Validator (MSV)](https://github.com/kohsuke/msv) that is needed if

using XML Schema or RelaxNG validation functionality

## License

Woodstox 4.x and above licensed under [Apache 2](http://www.apache.org/licenses/LICENSE-2.0.txt) license.

## Documentation etc

### Configuration

Most configuration is handled using standard Stax mechanism, property access via

* `XMLInputFactory.setProperty(propertyName, value)` for configuring XML reading aspects

* `XMLOutputFactory.setProperty(propertyName, value)` for configuring XML writing aspects

Names of properties available, including standard Stax 1.x ones, are documented in a series of blog posts:

* [Stax 1.x](https://github.com/FasterXML/woodstox/wiki/Configuring-Woodstox-I-%E2%80%90-Basic-Stax-Properties) standard configuration properties

* [Stax2 extension](https://github.com/FasterXML/woodstox/wiki/Configuring-Woodstox-II-%E2%80%90-Stax2-Properties) configuration properties

* [Woodstox-specific](https://github.com/FasterXML/woodstox/wiki/Configuring-Woodstox-III-%E2%80%90-Woodstox%E2%80%90Specific-Properties) configuration properties

## Support

### Community support

Woodstox is supported by the community via the mailing list:

[woodstox-user](https://groups.google.com/forum/#!forum/woodstox-user)

### Enterprise support

Available as part of the Tidelift Subscription.

The maintainers of `woodstox` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/maven-com-fasterxml-woodstox-woodstox-core?utm_source=maven-com-fasterxml-woodstox-woodstox-core&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

## Contributing

For simple bug reports and fixes, and feature requests, please simply use projects

[Issue Tracker](../../issues), with exception of security-related issues for which

we recommend filing a

[Tidelift security contact](https://tidelift.com/security) (NOTE: you do NOT have to be

a subscriber to do this).

## Other

* Check out [project Wiki](../../wiki) for javadocs