com.yahoo.elide.jsonapi

Class JsonApiMapper

java.lang.Object

com.yahoo.elide.jsonapi.JsonApiMapper

public class JsonApiMapper
extends Object

Serializer/Deserializer for JSON API.

Constructor Summary

Constructors

Constructor and Description
JsonApiMapper() Instantiates a new Json Api Mapper.
JsonApiMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Instantiates a new Json Api Mapper.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Gets object OBJECT_MAPPER.
JsonApiDocument	readJsonApiDocument(com.fasterxml.jackson.databind.JsonNode node) Read json api document.
JsonApiDocument	readJsonApiDocument(String doc) Read json api document.
List<Patch>	readJsonApiPatchExtDoc(String doc) Read json api patch ext doc.
JsonApiDocument	readJsonApiPatchExtValue(com.fasterxml.jackson.databind.JsonNode value) Read json api patch ext value.
com.fasterxml.jackson.databind.JsonNode	toJsonObject(JsonApiDocument jsonApiDocument) To json object.
String	writeJsonApiDocument(JsonApiDocument jsonApiDocument) Write out JSON API Document as a string.
String	writeJsonApiDocument(com.fasterxml.jackson.databind.JsonNode node) Write json api document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonApiMapper

public JsonApiMapper()

Instantiates a new Json Api Mapper.

JsonApiMapper

public JsonApiMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Instantiates a new Json Api Mapper.

Parameters:

mapper - Custom object mapper to use internally for serializing/deserializing

Method Detail

writeJsonApiDocument

public String writeJsonApiDocument(JsonApiDocument jsonApiDocument)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Write out JSON API Document as a string.

Parameters:

jsonApiDocument - the json api document

Returns:

Document as string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

toJsonObject

public com.fasterxml.jackson.databind.JsonNode toJsonObject(JsonApiDocument jsonApiDocument)

To json object.

Parameters:

jsonApiDocument - the json api document

Returns:

the json node

writeJsonApiDocument

public String writeJsonApiDocument(com.fasterxml.jackson.databind.JsonNode node)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Write json api document.

Parameters:

node - the node

Returns:

the string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

readJsonApiDocument

public JsonApiDocument readJsonApiDocument(String doc)
                                    throws IOException

Read json api document.

Parameters:

doc - the doc

Returns:

the json api document

Throws:

IOException - the iO exception

readJsonApiDocument

public JsonApiDocument readJsonApiDocument(com.fasterxml.jackson.databind.JsonNode node)
                                    throws IOException

Read json api document.

Parameters:

node - the node

Returns:

the json api document

Throws:

IOException - the iO exception

readJsonApiPatchExtValue

public JsonApiDocument readJsonApiPatchExtValue(com.fasterxml.jackson.databind.JsonNode value)
                                         throws com.fasterxml.jackson.core.JsonProcessingException

Read json api patch ext value.

Parameters:

value - the value

Returns:

the json api document

Throws:

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

readJsonApiPatchExtDoc

public List<Patch> readJsonApiPatchExtDoc(String doc)
                                   throws IOException

Read json api patch ext doc.

Parameters:

doc - the doc

Returns:

the list

Throws:

IOException - the iO exception

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Gets object OBJECT_MAPPER.

Returns:

the object OBJECT_MAPPER