Quickstart - Jackson

Project Dependencies

To use the unit-api with Jackson you need to include the following dependencies to your pom.xml/build.gradle file:

Gradle

implementation("com.raynigon.unit-api:jackson-module:1.1.7")

Maven

<dependency>
    <groupId>com.raynigon.unit-api</groupId>
    <artifactId>jackson-module</artifactId>
    <version>1.1.7</version>
</dependency>

Usage

You can declare your model like this:

public class BasicEntity {

    public String id;

    @JsonUnit(KilometrePerHour.class)
    public Quantity<Speed> speed;
}

Jackson will now accept any quantity and convert it to the given unit. The following examples will be accepted by Jackson:

Number

{
  "id": "65bf1872-d197-4d72-9950-2b7b4d74a674",
  "speed": 80
}

String

{
  "id": "65bf1872-d197-4d72-9950-2b7b4d74a674",
  "speed": "80"
}

Object

{
  "id": "65bf1872-d197-4d72-9950-2b7b4d74a674",
  "speed": {
    "value:" 80,
    "unit": "km/h"
  }
}

String in km/h

{
  "id": "65bf1872-d197-4d72-9950-2b7b4d74a674",
  "speed": "80 km/h"
}

String in m/s

{
  "id": "65bf1872-d197-4d72-9950-2b7b4d74a674",
  "speed": "22.2222 m/s"
}

Every example will result in having the speed property with a value of 80 and the unit "km/h".