https://github.com/fasterxml/jackson-datatype-joda
Extension module to properly support full datatype set of Joda datetime library
https://github.com/fasterxml/jackson-datatype-joda
Last synced: 21 days ago
JSON representation
Extension module to properly support full datatype set of Joda datetime library
- Host: GitHub
- URL: https://github.com/fasterxml/jackson-datatype-joda
- Owner: FasterXML
- License: apache-2.0
- Created: 2011-09-09T21:09:21.000Z (over 13 years ago)
- Default Branch: 2.19
- Last Pushed: 2025-04-10T03:46:30.000Z (22 days ago)
- Last Synced: 2025-04-10T04:34:56.575Z (22 days ago)
- Language: Java
- Homepage:
- Size: 2.15 MB
- Stars: 142
- Watchers: 12
- Forks: 84
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[Jackson](http://jackson.codehaus.org) module (jar)
to support JSON serialization and deserialization of
[Joda](http://joda-time.sourceforge.net/) data types.
## Status
[](https://travis-ci.org/FasterXML/jackson-datatype-joda)
[](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.datatype/jackson-datatype-joda/)
[](https://www.javadoc.io/doc/com.fasterxml.jackson.datatype/jackson-datatype-joda)
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](https://www.apache.org/licenses/LICENSE-2.0.txt)
## Usage
Since this module extends basic [Jackson databind](../../../jackson-databind) functionality, you may want to check out
documentation at [Jackson-docs](../../../jackson-docs) first.
### Maven dependency
To use module on Maven-based projects, use following dependency:
```xml
com.fasterxml.jackson.datatype
jackson-datatype-joda
2.17.1
```
(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):
```java
ObjectMapper mapper = JsonMapper.builder().addModule(new JodaModule()).build();
```
Using older style (that is being phased out):
```java
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JodaModule());
```
### Reading and Writing Joda types
After registering Joda module, [Jackson Databind](../../../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
```java
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:
```java
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](../../wiki) for more information (javadocs, downloads).