FasterXML/jackson-datatype-joda

Extension module to properly support full datatype set of Joda datetime library

Jackson module (jar) to support JSON serialization and deserialization of Joda data types.

Status

Module has been production-ready since version 2.0, and offers relatively extensive support for Joda datatypes. Contributions are always welcome -- not all types are yet supported; and we may want to support even wider alternative formats on input side.

License

Apache License 2.0

Usage

Since this module extends basic Jackson databind functionality, you may want to check out documentation at Jackson-docs first.

Maven dependency

To use module on Maven-based projects, use following dependency:

<dependency>
  <groupId>com.fasterxml.jackson.datatype</groupId>
  <artifactId>jackson-datatype-joda</artifactId>
  <version>2.17.1</version>
</dependency>    

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

Registering module

To use Joda datatypes with Jackson, you will first need to register the module first (same as with all Jackson datatype modules):

ObjectMapper mapper = JsonMapper.builder().addModule(new JodaModule()).build();

Using older style (that is being phased out):

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JodaModule());

Reading and Writing Joda types

After registering Joda module, Jackson Databind will be able to write values of supported Joda types as JSON (and other formats Jackson supports), and read Joda values from same formats.

With JSON, for example, following would work

public class Bean {
  public DateTime start;
}

final String INPUT_JSON = "{\"start\" : \"1972-12-28T12:00:01.000Z\"}";
Bean bean = mapper.readValue(INPUT_JSON, Bean.class);

and property start of Bean would have expected DateTime value.

Conversely, you can produce JSON (and other supported formats) simply with:

String json = mapper.writeValueAsString(bean);
Assert.assertEquals(INPUT_JSON, json);

Compatibility

Module works with Joda version 2.9 and higher (CI tests compatibility since module version 2.14), even if it declares dependency to a newer version. This means that it is possible to use with older version by using Maven dependency override.

More

See Wiki for more information (javadocs, downloads).