This repository has been archived by the owner on Nov 7, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3d819a1
commit 1cfbd83
Showing
1 changed file
with
4 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,5 @@ | ||
| Project for [Jackson](https://github.com/FasterXML/jackson) module (jar) | ||
| that adds supports for JDK datatypes included in version 8 which can not be directly | ||
| supported by core databind due to baseline being JDK 6, excluding following: | ||
| **NOTE**: This module has become part of [Jackson Java 8 Modules](../../../jackson-modules-java8) | ||
| as of Jackson 2.8.5 | ||
|
|
||
|
|
||
| * New Date types are supported by [JSR-310 module](../../../jackson-datatype-jsr310) | ||
| * Support for parameter names is via [Parameter Names](../../../jackson-module-parameter-names) module | ||
|
|
||
| ## Status | ||
|
|
||
| [](https://travis-ci.org/FasterXML/jackson-datatype-jdk8) | ||
| [](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/) | ||
| [](http://www.javadoc.io/doc/com.fasterxml.jackson.datatype/jackson-datatype-jdk8) | ||
|
|
||
| As of Jackson 2.5, this module is stable and considered production ready. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Maven dependency | ||
|
|
||
| To use module on Maven-based projects, use following dependency: | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>com.fasterxml.jackson.datatype</groupId> | ||
| <artifactId>jackson-datatype-jdk8</artifactId> | ||
| <version>2.6.3</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| (or whatever version is most up-to-date at the moment) | ||
|
|
||
| ### Registering module | ||
|
|
||
| Like all standard Jackson modules (libraries that implement Module interface), registration is done as follows: | ||
|
|
||
| ```java | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| mapper.registerModule(new Jdk8Module()); | ||
| // Or, the more fluent version: ObjectMapper mapper = new ObjectMapper().registerModule(new Jdk8Module()); | ||
| ``` | ||
|
|
||
| after which functionality is available for all normal Jackson operations: | ||
| you can read JSON into supported JDK8 types, as well as write values of such types as JSON, so that for example: | ||
|
|
||
| ```java | ||
| class Contact { | ||
| private final String name; | ||
| private final Optional<String> email; | ||
|
|
||
| public Contact(String name, Optional<String> email) { | ||
| this.name = name; | ||
| this.email = email; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public Optional<String> getEmail() { | ||
| return email; | ||
| } | ||
| } | ||
|
|
||
| ... | ||
|
|
||
| Contact nullEmail = new Contact("Example Co.", null); | ||
| String nullEmailJson = mapper.writeValueAsString(nullEmail); | ||
| // prints: {"name":"Example Co.","email":null} | ||
| System.out.println(nullEmailJson); | ||
|
|
||
| Contact emptyEmail = new Contact("Example Co.", Optional.empty()); | ||
| String emptyEmailJson = mapper.writeValueAsString(emptyEmail); | ||
| // prints: {"name":"Example Co.","email":null} | ||
| System.out.println(emptyEmailJson); | ||
|
|
||
| Contact withEmail = new Contact("Example Co.", Optional.of("info@example.com")); | ||
| String withEmailJson = mapper.writeValueAsString(withEmail); | ||
| // prints: {"name":"Example Co.","email":"info@example.com"} | ||
| System.out.println(withEmailJson); | ||
| ``` | ||
|
|
||
| ## More | ||
|
|
||
| See [Wiki](../../wiki) for more information (javadocs, downloads). | ||
| This repo still exists to allow release of patch versions of older versions; it will be hidden (made private) | ||
| in near future. |