https://github.com/oleg-cherednik/json-jackson-impl
An implementation of json-api for Jackson Project.
https://github.com/oleg-cherednik/json-jackson-impl
jackson jackson-json java java-8 java-json java-json-library json json-api
Last synced: about 1 month ago
JSON representation
An implementation of json-api for Jackson Project.
- Host: GitHub
- URL: https://github.com/oleg-cherednik/json-jackson-impl
- Owner: oleg-cherednik
- Created: 2016-12-13T18:59:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T08:55:50.000Z (about 1 year ago)
- Last Synced: 2024-12-29T02:15:01.435Z (4 months ago)
- Topics: jackson, jackson-json, java, java-8, java-json, java-json-library, json, json-api
- Language: Java
- Homepage: https://github.com/oleg-cherednik/json-jackson-impl
- Size: 518 KB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://maven-badges.herokuapp.com/maven-central/ru.oleg-cherednik.jackson/jackson-utils)
[](https://javadoc.io/doc/ru.oleg-cherednik.jackson/jackson-utils)
[](https://badgen.net/)
[](http://www.apache.org/licenses/LICENSE-2.0.txt)
[](https://github.com/oleg-cherednik/jackson-utils/actions)
[](https://snyk.io/test/github/oleg-cherednik/jackson-utils?targetFile=build.gradle)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Foleg-cherednik%2Fjackson-utils?ref=badge_shield)
[](https://app.codacy.com/gh/oleg-cherednik/jackson-utils/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade&branch=master)
[](https://app.codacy.com/gh/oleg-cherednik/jackson-utils/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage&branch=master)
develop
[](https://github.com/oleg-cherednik/jackson-utils/actions)
[](https://app.codacy.com/gh/oleg-cherednik/jackson-utils/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade&branch=develop)
[](https://app.codacy.com/gh/oleg-cherednik/jackson-utils/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage&branch=develop)
# jackson-utils
> [Jackson Project](https://github.com/FasterXML/jackson) usability utilities.
> It's designed to add additional features like easy and centralized configuration,
> builder or static method set. Artifact does not include direct `Jackson Project`.
> It is up to you to add them into your project.
## Features
* Encapsulate all checked exceptions from Jackson with custom runtime exception;
* A central place for configuration;
* A central place for holding `ObjectMapper` instances;
* Utility class to make most common operations much more comfortable to use;
* Ability to change `Zone` to save `ZonedDateTime` independently of original zone;
* `ByteBuffer`/`InputStream` support for objects, lists and maps;
* Lazy read support for list from `Writer`;
* Read numeric as `Integer`, `Long`, `BigInteger` or `Double` (but not only as `Double`);
* Advanced `Reader`/`Writer` support for `enum`.
## Gradle
```groovy
implementation 'ru.oleg-cherednik.jackson:jackson-utils:2.7'
```
_Optional dependencies (e.g. Jackson of version __2.15.3__):_
```groovy
implementation 'com.fasterxml.jackson.module:jackson-module-afterburner:2.15.3'
implementation 'com.fasterxml.jackson.module:jackson-module-parameter-names:2.15.3'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.15.3'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.15.3'
```
## Maven
```xml
ru.oleg-cherednik.jackson
jackson-utils
2.7
```
_Optional dependencies (e.g. Jackson of version __2.15.3__):_
```xml
com.fasterxml.jackson.module
jackson-module-afterburner
2.15.3
com.fasterxml.jackson.module
jackson-module-parameter-names
2.15.3
com.fasterxml.jackson.datatype
jackson-datatype-jdk8
2.15.3
com.fasterxml.jackson.datatype
jackson-datatype-jsr310
2.15.3
```
__Note:__ `jackson-utils` does not contain dependency to the specific `Jackson Project`
version, so you have to add any version additionally
## Usage
To simplify usage of _jackson-utils_, there're following classes:
* [JacksonUtils](#jacksonutils-class) - utility class with set of methods to use json transformation;
* [EnumId](#work-with-enum) - advanced enum serialization support.
### JacksonUtils class
#### Read json from `String`
##### `String` to a custom object type (but not a collection)
```java
class Data {
int intVal;
String strVal;
}
```
```java
String json = """
{
"intVal" : 666,
"strVal" : "omen"
}
""";
Data data = JacksonUtils.readValue(json, Data.class);
```
##### `String` to a list of custom object type
```java
class Data {
int intVal;
String strVal;
}
```
```java
String json = """
[
{
"intVal" : 555,
"strVal" : "victory"
},
{
"intVal" : 666,
"strVal" : "omen"
}
]
""";
List res = JacksonUtils.readList(json, Data.class);
```
##### `String` to a map of custom object type
###### Map with `String` keys and `Map` or primitive types as values
```java
String json = """
{
"victory" : {
"intVal" : 555,
"strVal" : "victory"
},
"omen" : {
"intVal" : 666,
"strVal" : "omen"
}
}
""";
Map map = JacksonUtils.readMap(json);
```
__Note:__ `map` values have either primitive type or `Map` or `List`.
###### `String` to a map with `String` keys and given type as value
```java
class Data {
int intVal;
String strVal;
}
```
```java
String json = """
{
"victory" : {
"intVal" : 555,
"strVal" : "victory"
},
"omen" : {
"intVal" : 666,
"strVal" : "omen"
}
}
""";
Map map = JacksonUtils.readMap(json, Data.class);
```
###### `String` to a map with `Integer` keys and given type as value
```java
class Data {
int intVal;
String strVal;
}
```
```java
String json = """
{
"1" : {
"intVal" : 555,
"strVal" : "victory"
},
"2" : {
"intVal" : 666,
"strVal" : "omen"
}
}
""";
Map map = JacksonUtils.readMap(json, Integer.class, Data.class);
```
#### Read json from `InputStream`
##### `InputStream` to a custom object type (but not a collection)
```java
class Data {
int intVal;
String strVal;
}
```
```json
{
"intVal": 666,
"strVal": "omen"
}
```
```java
try(InputStream in = ...) {
Data data = JacksonUtils.readValue(in, Data.class);
}
```
##### `InputStream` to a list of custom object type
##### Read eager
```java
class Data {
int intVal;
String strVal;
}
```
```json
[
{
"intVal": 555,
"strVal": "victory"
},
{
"intVal": 666,
"strVal": "omen"
}
]
```
```java
try (InputStream in = ...) {
List res = JacksonUtils.readList(in, Data.class);
}
```
##### Read lazy
```java
class Data {
int intVal;
String strVal;
}
```
```json
[
{
"intVal": 555,
"strVal": "victory"
},
{
"intVal": 666,
"strVal": "omen"
}
]
```
```java
try(InputStream in = ...) {
Iterator it = JacksonUtils.readListLazy(in, Data.class);
while (it.hasNext()) {
Data data = it.next();
}
}
```
##### `InputStream` to a map of custom object type
###### `InputStream` to a map with `String` keys and `Map` or primitive types as values
```json
{
"victory": {
"intVal": 555,
"strVal": "victory"
},
"omen": {
"intVal": 666,
"strVal": "omen"
}
}
```
```java
try (InputStream in = ...) {
Map map = JacksonUtils.readMap(in);
}
```
__Note:__ `map` values have either primitive type or `Map` or `List`.
###### `InputStream` to a map with `String` keys and given type as value
```java
class Data {
int intVal;
String strVal;
}
```
```json
{
"victory": {
"intVal": 555,
"strVal": "victory"
},
"omen": {
"intVal": 666,
"strVal": "omen"
}
}
```
```java
try (InputStream in = ...) {
Map map = JacksonUtils.readMap(in, Data.class);
}
```
###### Map with `Integer` keys and given type as value
```java
class Data {
int intVal;
String strVal;
}
```
```json
{
"1": {
"intVal": 555,
"strVal": "victory"
},
"2": {
"intVal": 666,
"strVal": "omen"
}
}
```
```java
try (InputStream in = ...) {
Map map = JacksonUtils.readMap(in, Integer.class, Data.class);
}
```
##### Links
* Home page: https://github.com/oleg-cherednik/jackson-utils
* Maven:
* __central:__ https://mvnrepository.com/artifact/ru.oleg-cherednik.jackson/jackson-utils
* __download:__ https://repo1.maven.org/maven2/ru/oleg-cherednik/jackson/jackson-utils