Skip to content
Uber-project for standard Jackson binary format backends: avro, cbor, protobuf, smile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
avro Merge branch '2.10' Jul 19, 2019
cbor Merge branch '2.10' May 7, 2019
docs/javadoc add 2.9 javadocs Jul 30, 2017
ion Merge branch '2.10' May 15, 2019
protobuf Manually merge moditect/module-info changes from 2.10 Mar 20, 2019
release-notes Merge branch '2.10' Jul 19, 2019
smile Manually merge moditect/module-info changes from 2.10 Mar 20, 2019
.gitattributes Start with cbor May 3, 2016
.gitignore Start with cbor May 3, 2016
.travis.yml forgot to add travis settings Feb 7, 2018
README.md ... Jun 14, 2019
pom.xml Merge branch '2.10' Jul 19, 2019

README.md

Overview

This is a multi-module umbrella project for Jackson standard binary dataformat backends.

Dataformat backends are used to support format alternatives to JSON, using general-purpose Jackson API. Formats included allow access using all 3 API styles (streaming, databinding, tree model).

For Jackson 2.x this is done by sub-classing Jackson core abstractions of:

  • All backends sub-class JsonFactory, which is factory for:
    • JsonParser for reading data (decoding data encoding in supported format)
      • JsonGenerator for writing data (encoding data using supported format)
    • Some backends sub-class ObjectMapper for additional support for databinding

there will be some changes (such as introduction of format-specific ObjectMapper sub-classes) in Jackson 3.0.

Branches

master branch is for developing the next major Jackson version -- 3.0 -- but there are active maintenance branches in which much of development happens:

  • 2.10 is for developing the next (and possibly last) minor 2.x version
  • 2.8 and 2.9 are for backported fixes for 2.8/2.9 patch versions

Older branches are usually not changed but are available for historic reasons. All released versions have matching git tags (jackson-dataformats-binary-2.9.4).

Note that since individual format modules used to live in their own repositories, older branches (before 2.8) and tags do not exist in this repository.

Binary formats included

Currently included backends are:

License

All modules are licensed under Apache License 2.0.

Status

Build Status

Maven dependencies

To use these format backends Maven-based projects, use following dependency:

<dependency>
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-[FORMAT]</artifactId>
  <version>2.9.9</version>
</dependency>

where [FORMAT] is one of supported modules (avro, cbor, smile etc)

Other Jackson binary backends

In addition to binary format backends hosted by FasterXML in this repo, there are other known Jackson backends for binary data formats. For example:

More

See Wiki for more information (javadocs).

You can’t perform that action at this time.