fr.gouv.vitam.common.json

Class JsonHandler

java.lang.Object

fr.gouv.vitam.common.json.JsonHandler

public final class JsonHandler
extends Object

JSON handler using Json format

Method Summary

Modifier and Type	Method and Description
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	checkLaxUnicity(String nodeName, com.fasterxml.jackson.databind.JsonNode node) node should have only one property ; simple value is allowed
static void	checkNullOrEmpty(String message, com.fasterxml.jackson.databind.JsonNode... nodes) Check if JsonNodes are not null and not empty
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	checkUnicity(String nodeName, com.fasterxml.jackson.databind.JsonNode node) node should have only one property
static com.fasterxml.jackson.databind.node.ArrayNode	createArrayNode()
static com.fasterxml.jackson.core.JsonGenerator	createJsonGenerator(OutputStream os) Creates a JSON generator for low-level json stream creation
static com.fasterxml.jackson.databind.node.ObjectNode	createObjectNode()
static com.fasterxml.jackson.databind.node.JsonNodeFactory	getFactory()
static com.fasterxml.jackson.databind.JsonNode	getFromBytes(byte[] value)
static com.fasterxml.jackson.databind.JsonNode	getFromFile(File file)
static <T> T	getFromFile(File file, Class<T> clasz)
static <T> T	getFromFileAsTypeRefence(File file, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
static <T> T	getFromFileLowerCamelCase(File file, Class<T> clasz)
static com.fasterxml.jackson.databind.JsonNode	getFromInputStream(InputStream stream) getFromInputStream, get JsonNode from stream
static <T> T	getFromInputStream(InputStream inputStream, Class<T> clasz)
static com.fasterxml.jackson.databind.JsonNode	getFromInputStream(InputStream stream1, InputStream stream2) getFromInputStream, get merged JsonNode from streams
static <T> T	getFromJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> clasz)
static <T> T	getFromJsonNodeLowerCamelCase(com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> clasz)
static com.fasterxml.jackson.databind.JsonNode	getFromString(String value)
static <T> T	getFromString(String value, Class<T> clasz)
static <T> T	getFromString(String value, Class<T> clasz, Class<?> parameterClazz)
static <T> T	getFromStringAsTypeRefence(String value, com.fasterxml.jackson.core.type.TypeReference<T> clasz)
static <T> T	getFromStringLowerCamelCase(String value, Class<T> clasz)
static Map<String,Object>	getMapFromInputStream(InputStream inputStream)
static <T> Map<String,T>	getMapFromInputStream(InputStream inputStream, Class<T> parameterClazz) transform an inputStream into a {Map} maps of template class
static Map<String,Object>	getMapFromString(String value)
static Map<String,String>	getMapStringFromString(String value)
static com.fasterxml.jackson.databind.JsonNode	getNodeByPath(com.fasterxml.jackson.databind.JsonNode node, String fieldPath, boolean deepCopy) Find a node with the given path
static com.fasterxml.jackson.databind.JsonNode	getParentNodeByPath(com.fasterxml.jackson.databind.JsonNode node, String fieldPath, boolean deepCopy) Find a parent of the node with the given path
static com.fasterxml.jackson.databind.node.ArrayNode	getSubArrayNode(com.fasterxml.jackson.databind.node.ArrayNode array, int offset, int limit) From one ArrayNode, get a new ArrayNode from offset to limit items
static String	prettyPrint(Object object)
static void	setNodeInPath(com.fasterxml.jackson.databind.node.ObjectNode node, String nodePath, com.fasterxml.jackson.databind.JsonNode value, boolean canCreate) Set a value in a node defined by the given path.
static List	toArrayList(com.fasterxml.jackson.databind.node.ArrayNode arrayNode) transform an ArrayNode (JSON Array) to an ArrayList
static com.fasterxml.jackson.databind.JsonNode	toJsonNode(Object object)
static String	unprettyPrint(Object object)
static boolean	validate(String value)
static void	writeAsFile(Object object, File file)
static void	writeAsOutputStream(Object object, OutputStream outputStream)
static String	writeAsString(Object object)
static InputStream	writeToInpustream(Object object)

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static final com.fasterxml.jackson.databind.node.JsonNodeFactory getFactory()

Returns:

the current factory

createObjectNode

public static final com.fasterxml.jackson.databind.node.ObjectNode createObjectNode()

Returns:

an empty ObjectNode

createArrayNode

public static final com.fasterxml.jackson.databind.node.ArrayNode createArrayNode()

Returns:

an empty ArrayNode

getFromString

public static final com.fasterxml.jackson.databind.JsonNode getFromString(String value)
                                                                   throws InvalidParseOperationException

Parameters:

value - in format String to transform

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

validate

public static final boolean validate(String value)
                              throws InvalidParseOperationException

Parameters:

value - in format String to transform

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

createJsonGenerator

public static final com.fasterxml.jackson.core.JsonGenerator createJsonGenerator(OutputStream os)
                                                                          throws IOException

Creates a JSON generator for low-level json stream creation

Parameters:

os - the output stream

Returns:

Throws:

IOException

getFromFile

public static final com.fasterxml.jackson.databind.JsonNode getFromFile(File file)
                                                                 throws InvalidParseOperationException

Parameters:

file - to transform

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromInputStream

public static final com.fasterxml.jackson.databind.JsonNode getFromInputStream(InputStream stream)
                                                                        throws InvalidParseOperationException

getFromInputStream, get JsonNode from stream

Parameters:

stream - to transform

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromInputStream

public static final com.fasterxml.jackson.databind.JsonNode getFromInputStream(InputStream stream1,
                                                                               InputStream stream2)
                                                                        throws InvalidParseOperationException

getFromInputStream, get merged JsonNode from streams

Parameters:

stream1 - to transform

stream2 - to transform and merge with

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromString

public static final <T> T getFromString(String value,
                                        Class<T> clasz)
                                 throws InvalidParseOperationException

Parameters:

value - to transform

clasz - the instance of target class

Returns:

the object of type clasz

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromStringAsTypeRefence

public static final <T> T getFromStringAsTypeRefence(String value,
                                                     com.fasterxml.jackson.core.type.TypeReference<T> clasz)
                                              throws InvalidParseOperationException

Parameters:

value - to transform

clasz - the instance of target class

Returns:

the object of type clasz

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromString

public static final <T> T getFromString(String value,
                                        Class<T> clasz,
                                        Class<?> parameterClazz)
                                 throws InvalidParseOperationException

Parameters:

value - in format String to transform

clasz - the instance of target class

parameterClazz - the the target class template parameters

Returns:

the object of type clasz

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromStringLowerCamelCase

public static final <T> T getFromStringLowerCamelCase(String value,
                                                      Class<T> clasz)
                                               throws InvalidParseOperationException

Parameters:

value - to transform

clasz - the instance of target class

Returns:

the object of type clasz

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromBytes

public static final com.fasterxml.jackson.databind.JsonNode getFromBytes(byte[] value)
                                                                  throws InvalidParseOperationException

Parameters:

value - in format byte to transform

Returns:

the jsonNode (ObjectNode or ArrayNode)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromFile

public static final <T> T getFromFile(File file,
                                      Class<T> clasz)
                               throws InvalidParseOperationException

Parameters:

file - to transform

clasz - the instance of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromFileAsTypeRefence

public static final <T> T getFromFileAsTypeRefence(File file,
                                                   com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
                                            throws InvalidParseOperationException

Parameters:

file - to transform

valueTypeRef - the type reference of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromFileLowerCamelCase

public static final <T> T getFromFileLowerCamelCase(File file,
                                                    Class<T> clasz)
                                             throws InvalidParseOperationException

Parameters:

file - to transform

clasz - the instance of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromJsonNode

public static final <T> T getFromJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                          Class<T> clasz)
                                   throws InvalidParseOperationException

Parameters:

jsonNode - the json object to transform

clasz - the instance of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromJsonNodeLowerCamelCase

public static final <T> T getFromJsonNodeLowerCamelCase(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                                        Class<T> clasz)
                                                 throws InvalidParseOperationException

Parameters:

jsonNode - the json object to get

clasz - the instance of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

toJsonNode

public static final com.fasterxml.jackson.databind.JsonNode toJsonNode(Object object)
                                                                throws InvalidParseOperationException

Parameters:

object - to transform

Returns:

the Json representation of the object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

writeAsString

public static final String writeAsString(Object object)
                                  throws InvalidParseOperationException

Parameters:

object - to transform

Returns:

the Json representation of the object (shall be prettyPrint)

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

prettyPrint

public static String prettyPrint(Object object)

Parameters:

object - to write

Returns:

the Json representation of the object in Pretty Print format

unprettyPrint

public static String unprettyPrint(Object object)

Parameters:

object - to transform

Returns:

the Json representation of the object in UnPretty Print format

writeAsFile

public static final void writeAsFile(Object object,
                                     File file)
                              throws InvalidParseOperationException

Parameters:

object - to write

file - to write object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

writeAsOutputStream

public static final void writeAsOutputStream(Object object,
                                             OutputStream outputStream)
                                      throws InvalidParseOperationException

Parameters:

object - to write

outputStream - the output stream

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

writeToInpustream

public static final InputStream writeToInpustream(Object object)
                                           throws InvalidParseOperationException

Parameters:

object -

Returns:

the InputStream for this object

Throws:

InvalidParseOperationException

checkNullOrEmpty

public static final void checkNullOrEmpty(String message,
                                          com.fasterxml.jackson.databind.JsonNode... nodes)

Check if JsonNodes are not null and not empty

Parameters:

message - default message within exception

nodes - to check

Throws:

IllegalArgumentException - if nodes are null or empty

checkUnicity

public static final Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> checkUnicity(String nodeName,
                                                                                           com.fasterxml.jackson.databind.JsonNode node)
                                                                                    throws InvalidParseOperationException

node should have only one property

Parameters:

nodeName - name to print in case of error

node - to check

Returns:

the couple property name and property value

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

checkLaxUnicity

public static final Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> checkLaxUnicity(String nodeName,
                                                                                              com.fasterxml.jackson.databind.JsonNode node)
                                                                                       throws InvalidParseOperationException

node should have only one property ; simple value is allowed

Parameters:

nodeName - name to print in case of error

node - to check

Returns:

the couple property name and property value

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getMapFromString

public static final Map<String,Object> getMapFromString(String value)
                                                 throws InvalidParseOperationException

Parameters:

value - to transform

Returns:

the corresponding HashMap

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getMapStringFromString

public static final Map<String,String> getMapStringFromString(String value)
                                                       throws InvalidParseOperationException

Parameters:

value - to transform

Returns:

the corresponding HashMap

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getMapFromInputStream

public static final Map<String,Object> getMapFromInputStream(InputStream inputStream)
                                                      throws InvalidParseOperationException

Parameters:

inputStream - to transform

Returns:

the corresponding HashMap

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getMapFromInputStream

public static final <T> Map<String,T> getMapFromInputStream(InputStream inputStream,
                                                            Class<T> parameterClazz)
                                                     throws InvalidParseOperationException

transform an inputStream into a {Map} maps of template class

Type Parameters:

T - the class template

Parameters:

inputStream - to transform

parameterClazz - type of the value on the Map

Returns:

the corresponding HashMap

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getFromInputStream

public static final <T> T getFromInputStream(InputStream inputStream,
                                             Class<T> clasz)
                                      throws InvalidParseOperationException

Parameters:

inputStream - to transform

clasz - the instance of target class

Returns:

the corresponding object

Throws:

InvalidParseOperationException - if parse JsonNode object exception occurred

getSubArrayNode

public static com.fasterxml.jackson.databind.node.ArrayNode getSubArrayNode(com.fasterxml.jackson.databind.node.ArrayNode array,
                                                                            int offset,
                                                                            int limit)

From one ArrayNode, get a new ArrayNode from offset to limit items

Parameters:

array - to get node data

offset - of array to get

limit - of array to get

Returns:

Sub ArrayNode

getNodeByPath

public static com.fasterxml.jackson.databind.JsonNode getNodeByPath(com.fasterxml.jackson.databind.JsonNode node,
                                                                    String fieldPath,
                                                                    boolean deepCopy)

Find a node with the given path

Parameters:

node - the parent Node within the search must be performed

fieldPath - the field to find in the root. use '.' to get sub-node (ex: parent.child.subNodeName)

deepCopy - if true, the returned node is a copy of the matching node, else return the original one

Returns:

the find node or null if not found.

getParentNodeByPath

public static com.fasterxml.jackson.databind.JsonNode getParentNodeByPath(com.fasterxml.jackson.databind.JsonNode node,
                                                                          String fieldPath,
                                                                          boolean deepCopy)

Find a parent of the node with the given path

Parameters:

node - the root Node within the search must be performed

fieldPath - the field to find in the root. use '.' to get sub-node (ex: ["parent","child","subNodeName"])

deepCopy - if true, the returned node is a copy of the matching node, else return the original one

Returns:

the parent of the node defined by the given path (in the findPath example, return 'child' node)

setNodeInPath

public static void setNodeInPath(com.fasterxml.jackson.databind.node.ObjectNode node,
                                 String nodePath,
                                 com.fasterxml.jackson.databind.JsonNode value,
                                 boolean canCreate)
                          throws InvalidParseOperationException

Set a value in a node defined by the given path. Create path nodes if needed

Parameters:

node - the rootNode

nodePath - the path of the node that must be updated/created

value - The new value of the node

canCreate - true if missing nodes muse be created. Else an error was thrown for missing nodes

Throws:

InvalidParseOperationException

toArrayList

public static List toArrayList(com.fasterxml.jackson.databind.node.ArrayNode arrayNode)

transform an ArrayNode (JSON Array) to an ArrayList

Parameters:

arrayNode - ArrayNode to transform

Returns:

list corresponding to the arrayNode in parameter