emenifee / jackson-dataformat-smile

Jackson extension that adds support for Smile (see http://wiki.fasterxml.com/SmileFormatSpec)

Overview

This Jackson extension handles reading and writing of data using Smile data format ("binary JSON"). It extends standard Jackson streaming API (JsonFactory, JsonParser, JsonGenerator), and as such works seamlessly with all the higher level data abstractions (data binding, tree model, and pluggable extensions).

Status

Module is fully usable, but depends on Jackson 2.0; older 1.x version is still available via Codehaus, and Jackson 1.x Download page.

Maven dependency

To use this extension on Maven-based projects, use following dependency:

<dependency>
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-smile</artifactId>
  <version>2.0.0-SNAPSHOT</version>
</dependency>

(or whatever version is most up-to-date at the moment)

Usage

Basic usage is by using SmileFactory in places where you would usually use JsonFactory:

SmileFactory f = new SmileFactory();
// can configure instance with 'SmileParser.Feature' and 'SmileGenerator.Feature'
ObjectMapper mapper = new ObjectMapper(f);
// and then read/write data as usual
SomeType value = ...;
byte[] smileData = mapper.writeValueAsBytes(value);
SomeType otherValue = mapper.readValue(smileData, SomeType.class);