com.anaptecs.jeaf.json.impl

Class JSONToolsImpl

java.lang.Object

com.anaptecs.jeaf.json.impl.JSONToolsImpl

All Implemented Interfaces:

com.anaptecs.jeaf.json.api.JSONTools

public class JSONToolsImpl
extends Object
implements com.anaptecs.jeaf.json.api.JSONTools

Constructor Summary

Constructors

Constructor and Description
JSONToolsImpl()

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.ObjectMapper	getDefaultObjectMapper() Method returns a JSON ObjectMapper that is configured as defined using ObjectMapperConfig and ModuleFactory.
<T> T	read(byte[] pBytes, Class<T> pType) Method deserializes the passed byte array into an object of the passed type.
<T> T	read(File pFile, Class<T> pType) Method deserializes the data from the passed file into an object of the passed type.
<T> T	read(InputStream pInputStream, Class<T> pType) Method deserializes the data of passed stream into an object of the passed type.
<T> T	read(Reader pReader, Class<T> pType) Method deserializes the data from the passed reader into an object of the passed type.
<T> T	read(String pContent, Class<T> pType) Method deserializes the passed string into an object of the passed type.
<T> List<T>	readToList(byte[] pBytes, Class<T> pType) Method deserializes the passed string into a List of objects of the passed type.
<T> List<T>	readToList(File pFile, Class<T> pType) Method deserializes the data from the passed file into a List of objects of the passed type.
<T> List<T>	readToList(InputStream pInputStream, Class<T> pType) Method deserializes the data of passed stream into a List of objects of the passed type.
<T> List<T>	readToList(Reader pReader, Class<T> pType) Method deserializes the data from the passed reader into a List of objects of the passed type.
<T> List<T>	readToList(String pJSONString, Class<T> pType) Method deserializes the passed string into a List of objects of the passed type.
void	writeObject(Object pObject, File pFile) Method serializes the passed object to the passed file.
void	writeObject(Object pObject, OutputStream pOutputStream) Method serializes the passed object to the passed stream.
void	writeObject(Object pObject, Writer pWriter) Method serializes the passed object to the passed writer.
void	writeObjects(Collection<?> pObjects, File pFile, Class<?> pObjectType) Method serializes the passed Collection to the passed file.
void	writeObjects(Collection<?> pObjects, OutputStream pOutputStream, Class<?> pObjectType) Method serializes the passed Collection to the passed stream.
void	writeObjects(Collection<?> pObjects, Writer pWriter, Class<?> pObjectType) Method serializes the passed Collection to the passed writer.
byte[]	writeObjectsToBytes(Collection<?> pObjects, Class<?> pObjectType) Method serializes the passed Collection as byte array.
String	writeObjectsToString(Collection<?> pObjects, Class<?> pObjectType) Method serializes the passed Collection as string.
byte[]	writeObjectToBytes(Object pObject) Method serializes the passed object as byte array.
String	writeObjectToString(Object pObject) Method serializes the passed object as string.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONToolsImpl

public JSONToolsImpl()

Method Detail

getDefaultObjectMapper

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

Method returns a JSON ObjectMapper that is configured as defined using ObjectMapperConfig and ModuleFactory.

Specified by:

getDefaultObjectMapper in interface com.anaptecs.jeaf.json.api.JSONTools

Returns:

ObjectMapper Object mapper that should be used for JSON serialization.

writeObject

public void writeObject(Object pObject,
                        OutputStream pOutputStream)
                 throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed object to the passed stream.

Specified by:

writeObject in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObject - Object that should be serialized as JSON. The parameter may be null.

pOutputStream - Stream to which the object should be written. The parameter must not be null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObject

public void writeObject(Object pObject,
                        Writer pWriter)
                 throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed object to the passed writer.

Specified by:

writeObject in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObject - Object that should be serialized as JSON. The parameter may be null.

pWriter - Writer to which the object should be written. The parameter must not be null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObject

public void writeObject(Object pObject,
                        File pFile)
                 throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed object to the passed file.

Specified by:

writeObject in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObject - Object that should be serialized as JSON. The parameter may be null.

pFile - File to which the object should be written. The parameter must not be null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjectToString

public String writeObjectToString(Object pObject)
                           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed object as string.

Specified by:

writeObjectToString in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObject - Object that should be serialized as JSON. The parameter may be null.

Returns:

String JSON serialized object as String. The method never returns null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjectToBytes

public byte[] writeObjectToBytes(Object pObject)
                          throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed object as byte array.

Specified by:

writeObjectToBytes in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObject - Object that should be serialized as JSON. The parameter may be null.

Returns:

byte[] JSON serialized object as byte array. The method never returns null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjects

public void writeObjects(Collection<?> pObjects,
                         OutputStream pOutputStream,
                         Class<?> pObjectType)
                  throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed Collection to the passed stream.

Specified by:

writeObjects in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObjects - Collection of objects that should be serialized as JSON. The parameter may be null.

pOutputStream - Stream to which the object should be written. The parameter must not be null.

pObjectType - Class object representing the type of objects that are inside the collection. As type info of Java generics is not present at runtime this information has to be passed as additional parameter.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjects

public void writeObjects(Collection<?> pObjects,
                         Writer pWriter,
                         Class<?> pObjectType)
                  throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed Collection to the passed writer.

Specified by:

writeObjects in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObjects - Collection of objects that should be serialized as JSON. The parameter may be null.

pWriter - Writer to which the object should be written. The parameter must not be null.

pObjectType - Class object representing the type of objects that are inside the collection. As type info of Java generics is not present at runtime this information has to be passed as additional parameter.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjects

public void writeObjects(Collection<?> pObjects,
                         File pFile,
                         Class<?> pObjectType)
                  throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed Collection to the passed file.

Specified by:

writeObjects in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObjects - Collection of objects that should be serialized as JSON. The parameter may be null.

pFile - File to which the object should be written. The parameter must not be null.

pObjectType - Class object representing the type of objects that are inside the collection. As type info of Java generics is not present at runtime this information has to be passed as additional parameter.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjectsToString

public String writeObjectsToString(Collection<?> pObjects,
                                   Class<?> pObjectType)
                            throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed Collection as string.

Specified by:

writeObjectsToString in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObjects - Collection of objects that should be serialized as JSON. The parameter may be null.

pObjectType - Class object representing the type of objects that are inside the collection. As type info of Java generics is not present at runtime this information has to be passed as additional parameter.

Returns:

String JSON serialized object as String. The method never returns null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

writeObjectsToBytes

public byte[] writeObjectsToBytes(Collection<?> pObjects,
                                  Class<?> pObjectType)
                           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method serializes the passed Collection as byte array.

Specified by:

writeObjectsToBytes in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pObjects - Collection of objects that should be serialized as JSON. The parameter may be null.

pObjectType - Class object representing the type of objects that are inside the collection. As type info of Java generics is not present at runtime this information has to be passed as additional parameter.

Returns:

String JSON serialized object as String. The method never returns null.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during serialization

read

public <T> T read(InputStream pInputStream,
                  Class<T> pType)
           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data of passed stream into an object of the passed type.

Specified by:

read in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pInputStream - Stream from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

T Object of passed type that was created. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

read

public <T> T read(Reader pReader,
                  Class<T> pType)
           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data from the passed reader into an object of the passed type.

Specified by:

read in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pReader - Reader from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

T Object of passed type that was created. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

read

public <T> T read(File pFile,
                  Class<T> pType)
           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data from the passed file into an object of the passed type.

Specified by:

read in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pFile - File from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

T Object of passed type that was created. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

read

public <T> T read(String pContent,
                  Class<T> pType)
           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the passed string into an object of the passed type.

Specified by:

read in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pContent - String from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

T Object of passed type that was created. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

read

public <T> T read(byte[] pBytes,
                  Class<T> pType)
           throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the passed byte array into an object of the passed type.

Specified by:

read in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pBytes - Byte array from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

T Object of passed type that was created. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

readToList

public <T> List<T> readToList(InputStream pInputStream,
                              Class<T> pType)
                       throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data of passed stream into a List of objects of the passed type.

Specified by:

readToList in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pInputStream - Stream from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

List List of objects of passed type that was created from the JSON data. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

readToList

public <T> List<T> readToList(Reader pReader,
                              Class<T> pType)
                       throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data from the passed reader into a List of objects of the passed type.

Specified by:

readToList in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pReader - Reader from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

List List of objects of passed type that was created from the JSON data. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

readToList

public <T> List<T> readToList(File pFile,
                              Class<T> pType)
                       throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the data from the passed file into a List of objects of the passed type.

Specified by:

readToList in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pFile - File from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

List List of objects of passed type that was created from the JSON data. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

readToList

public <T> List<T> readToList(String pJSONString,
                              Class<T> pType)
                       throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the passed string into a List of objects of the passed type.

Specified by:

readToList in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pJSONString - String from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

List List of objects of passed type that was created from the JSON data. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization

readToList

public <T> List<T> readToList(byte[] pBytes,
                              Class<T> pType)
                       throws com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException

Method deserializes the passed string into a List of objects of the passed type.

Specified by:

readToList in interface com.anaptecs.jeaf.json.api.JSONTools

Parameters:

pBytes - Byte array from which the data should be read. The parameter must not be null.

pType - Type of the object that should be created. The parameter must not be null.

Returns:

List List of objects of passed type that was created from the JSON data. The method may return null if null was serialized.

Throws:

com.anaptecs.jeaf.xfun.api.errorhandling.JEAFSystemException - if an error occurs during deserialization