The java-json-object-mapper's intro from good-tech

java-json-object-mapper's Introduction

Java JSON Object Mapper

The JSON Object Mapper will hydrate an entity from a JSON string.

Declaring our Entity.

/**
 * Example entity for testing the JSON object mapper.
 */
public class GeoLocation {
    private double latitude;
    private double longitude;

    public void setLatitude (double latitude) {
        this.latitude = latitude;
    }

    public double getLatitude () {
        return latitude;
    }

    public void setLongitude (double longitude) {
        this.longitude = longitude;
    }

    public double getLongitude () {
        return longitude;
    }
}

Mapping our JSON to our Entity.

GeoLocation location = JSONObjectMapper.mapJSONStringToEntity(
        "{ \"latitude\": 46.0231, \"longitude\": -116.1239 }",
        GeoLocation.class
);

Note: The properties of your entity class must match the JSON keys.

Exceptions

The JSONObjectMapper can throw one of two exceptions:

InvalidJSONStringException

catch (InvalidJSONStringException e) {
          // The JSON string was invalid.
}

FatalMappingException

catch (FatalMappingException e) {
          // The entity was not compatible.
}

Support or Contact

Having trouble with the JSON Object Mapper? Generate the documentation with JavaDoc or contact me, (@scottbyrns) directly and I'll help you sort it out.

Recommend Projects