co.ecg.alpaca.toolkit.helper

Class JSONHelper

java.lang.Object

co.ecg.alpaca.toolkit.helper.JSONHelper

public class JSONHelper
extends Object

A utility class for JSON handling

Author:

Matthew Keathley on 4/4/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSONHelper.BroadWorksServerPostProcessor
static class	JSONHelper.OptionalTypeAdapter A handler for serialization and deserialization of Optionals.
static class	JSONHelper.PolymorphicDeserializer<T> Deserializer Class for SuperTypes.

Constructor Summary

Constructors

Constructor and Description
JSONHelper()

Method Summary

Modifier and Type	Method and Description
static com.google.gson.Gson	getDeserializerGSON(BroadWorksServer broadWorksServer) Retrieves a deserializer GSON object for standard deserialization of JSON to Alpaca Objects
static com.google.gson.Gson	getDeserializerGSON(BroadWorksServer broadWorksServer, String sourceDefaultDomain, boolean convertDefaultDomain) Retrieves a deserializer GSON object for standard deserialization of JSON to Alpaca Objects
static com.google.gson.Gson	getSerializerGSON() Retrieves a serializer GSON object for standard creation of JSON from Alpaca Objects
static <T extends BroadWorksObjectInformation> T	inputBroadWorksInformation(Type type, FileReader fileReader, BroadWorksServer broadWorksServer) Imports a BroadWorksObjectInformation class from the specified File
static <T extends BroadWorksObjectInformation> void	outputBroadWorksInformation(T information, FileWriter fileWriter) Outputs a BroadWorksObjectInformation class as JSON to the specified FileOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONHelper

public JSONHelper()

Method Detail

getSerializerGSON

public static com.google.gson.Gson getSerializerGSON()

Retrieves a serializer GSON object for standard creation of JSON from Alpaca Objects

Returns:

The GSON object

getDeserializerGSON

public static com.google.gson.Gson getDeserializerGSON(BroadWorksServer broadWorksServer,
                                                       String sourceDefaultDomain,
                                                       boolean convertDefaultDomain)
                                                throws HelperException

Retrieves a deserializer GSON object for standard deserialization of JSON to Alpaca Objects

Parameters:

broadWorksServer - The BroadWorksServer to deserialize into.

sourceDefaultDomain - The SourceDefault domain if conversion is not expected

convertDefaultDomain - Flag to convert the deserialized information to the new default domain of the provided BroadWorksServer

Returns:

The GSON object

Throws:

HelperException - Thrown if the BroadWorksServer or SourceDefaultDomain is null

getDeserializerGSON

public static com.google.gson.Gson getDeserializerGSON(BroadWorksServer broadWorksServer)
                                                throws HelperException

Retrieves a deserializer GSON object for standard deserialization of JSON to Alpaca Objects

Parameters:

broadWorksServer - The BroadWorksServer to deserialize into.

Returns:

The GSON object

Throws:

HelperException

outputBroadWorksInformation

public static <T extends BroadWorksObjectInformation> void outputBroadWorksInformation(T information,
                                                                                       FileWriter fileWriter)
                                                                                throws HelperException

Outputs a BroadWorksObjectInformation class as JSON to the specified FileOutputStream

Type Parameters:

T - The Information type

Parameters:

information - The input information

fileWriter - The output stream for the generated JSON

Throws:

HelperException - Throw if an error occurs while outputting the information.

inputBroadWorksInformation

public static <T extends BroadWorksObjectInformation> T inputBroadWorksInformation(Type type,
                                                                                   FileReader fileReader,
                                                                                   BroadWorksServer broadWorksServer)
                                                                            throws HelperException

Imports a BroadWorksObjectInformation class from the specified File

Type Parameters:

T - The Information type

Parameters:

type - The Information type

fileReader - The file reader for the JSON object

broadWorksServer - The BroadWorksServer to deserialize into.

Returns:

Returns a BroadWorksObjectInformation from the reader.

Throws:

HelperException - Throw if an error occurs on input.