com.sappenin.utils.json

Interface JsonUtils

All Known Implementing Classes:

JsonUtils.Impl

public interface JsonUtils

Utilities for Dealing with JSON (via Jackson).

Author:

David Fuelling

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JsonUtils.Impl An implementation of JsonUtils.

Method Summary

Methods

Modifier and Type	Method and Description
<P> P	fromJson(javax.servlet.http.HttpServletRequest httpServletRequest, JsonUtilsClassTypeMapper jsonUtilsClassTypeMapper) Convert the body of an HttpServletRequest into an of the proper type as based upon an instance of JsonUtilsClassTypeMapper.
<P> P	fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode, Class<P> jsonNodeClass) Convert a JsonNode into an object of the proper type as found in the "@class" directive in the JsonNode.
<P> P	fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode, JsonUtilsClassTypeMapper jsonUtilsClassTypeMapper) Convert the body of an HttpServletRequest into an of the proper type as based upon an instance of JsonUtilsClassTypeMapper.
<P> String	toJson(P payload) Convert an object of type
<P> String	toJsonUnchecked(P payload) Convert an object of type

Method Detail

toJson

<P> String toJson(P payload)
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an object of type

into a Json String.

Parameters:

payload -

Returns:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

toJsonUnchecked

<P> String toJsonUnchecked(P payload)
                       throws RuntimeException

Convert an object of type

into a Json String. Catch any exceptions of type JsonProcessingException and throw them as RuntimeException.

Parameters:

payload -

Returns:

Throws:

RuntimeException

fromJson

<P> P fromJson(javax.servlet.http.HttpServletRequest httpServletRequest,
             JsonUtilsClassTypeMapper jsonUtilsClassTypeMapper)
           throws IOException,
                  ClassNotFoundException

Convert the body of an HttpServletRequest into an of the proper type as based upon an instance of JsonUtilsClassTypeMapper.

Parameters:

httpServletRequest - An HttpServletRequest with an InputStream containing a JSON payload.

jsonUtilsClassTypeMapper - An instance of JsonUtilsClassTypeMapper to map the incoming JSON payload to a typed Java class.

Returns:

Throws:

IOException

ClassNotFoundException

fromJson

<P> P fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
             Class<P> jsonNodeClass)
           throws ClassNotFoundException

Convert a JsonNode into an object of the proper type as found in the "@class" directive in the JsonNode.

Parameters:

jsonNode - A JsonNode to deserialize into a Java object.

jsonNodeClass - The expected Java Class to deserialize the incoming JSON payload to.

Returns:

Throws:

ClassNotFoundException

fromJson

<P> P fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
             JsonUtilsClassTypeMapper jsonUtilsClassTypeMapper)
           throws ClassNotFoundException

Convert the body of an HttpServletRequest into an of the proper type as based upon an instance of JsonUtilsClassTypeMapper.

Type Parameters:

P -

Parameters:

jsonNode - A JsonNode to deserialize into a Java object.

jsonUtilsClassTypeMapper - An instance of JsonUtilsClassTypeMapper to map the incoming JSON payload to a typed Java class.

Returns:

Throws:

ClassNotFoundException