Class: AbstractJsonConverter

Base Converter to convert JSON to VoltScript datatype or object and vice versa.
This is an abstract class only, a derived class must be used.

Name	Type	Comment
`Public labelName`	`As String`
`Public prefix`	`As String`

`forPropertyName(propertyName As String) As AbstractJsonConverter`
`fromHelper(helper As JsonConversionHelper) As AbstractJsonConverter`
`fromJson(source As JsonObject) As Variant`
`getMeTypeForDebug() As String`
`isReturnObj() As Boolean`
`toJson(source As Variant) As Variant`
`cleanup()`
`deserialize(holder As JsonConversionHolder, source As JsonObject)`
`New()`
`serialize(source As Variant, target As JsonObject)`

Public Function forPropertyName(propertyName As String) As AbstractJsonConverter
Defines a custom property name from the relevant Class to use. If not used, the code will look for a property that matches the label in the JSON
idx	Argument	Data Type	Attributes	Comments
1	propertyName	String		Property name to look for in the relevant Class. E.g. if the JSON has a label "lastName" but your class uses the property "surname", pass "surname" as the property to write to

Code Sample
%REM Ensures that when the surnameConverter extracts its value, it writes it to the lastName property of the target VoltScript object. %END REM Dim surnameConverter as New JsonScalarConverter Call surnameConverter.forPropertyName("lastName")

Public Function fromHelper(helper As JsonConversionHelper) As AbstractJsonConverter
Passes the current helper into the converter, so we know whether or not to suppress errors. <b>NOTE:</b> This method is called from the JsonConversionHelper, you should not call it in your own custom code.
idx	Argument	Data Type	Attributes	Comments
1	helper	JsonConversionHelper		Helper from which the converter is being used

Public Function fromJson(source As JsonObject) As Variant
Main function to convert JSON value to VltScript value. Needs to be overridden in derived class.
idx	Argument	Data Type	Attributes	Comments
1	source	JsonObject		JSON object to deserialize from

Throws Exceptions
Message	Error Code	Comments
Not Implemented	1501

Public Function getMeTypeForDebug() As String
Creates a prefix for debug messages

Code Sample
%REM The following code can be included in a base class's method. TypeName() will be called on the current object. So if debug is enabled, a message will be written that makes it clear which derived class's fromJson() method is being called. %END REM Call DebugPrint_Samsara("Entering " & Me.getMeTypeForDebug & ".fromJson")

Public Function isReturnObj() As Boolean
Whether or not the converter returns a VoltScript object or VoltScript scalar or scalar array. This function is used to determine whether "Set" needs to be used to write the result to a variable. Default version of the function returns True.

Code Sample
%REM A converter is expected to know whether it should return a scalar or a VoltScript object. The default is false, that it only returns scalars. This function is used to determine whether or not there is a need to call Set. In future versions, where Return is implemented in functions, this may no longer be required. %END REM Dim returnVal as Variant If Me.isReturnObj Then Set returnVal = Me.fromJson(jsonObj) Else returnVal = Me.fromJson(jsonObj) End If

Public Function toJson(source As Variant) As Variant
Main function to convert VoltScript value to JSON value. Needs to be overridden in derived class.
idx	Argument	Data Type	Attributes	Comments
1	source	Variant		Variant containing the propery to be serialized

Throws Exceptions
Message	Error Code	Comments
Not Implemented	501

Public Sub cleanup()
Resets globals

Code Sample
%REM Runs an execute statement, which needs global variables to store the value and the object from which to extract it. Whether successful or unsoccessful, the finally block's call to cleanup() sub re-initialises samsaraObj, samsaraVal and samsaraParamVals to empty variants. %END REM Try execString = \|samsaraVal = samsaraObj.\| & propName Execute(execString) Catch Error 1400, "Unable to set " & labelName & " to extracted value" Finally Call Me.cleanup() End Try

Public Sub deserialize(holder As JsonConversionHolder, source As JsonObject)
Deserializes a JSON object into a property in a holder object
idx	Argument	Data Type	Attributes	Comments
1	holder	JsonConversionHolder		Object to deseralize into
2	source	JsonObject		JSON object to deserialize from

Throws Exceptions
Message	Error Code	Comments
Not Implemented	1501

Public Sub New()
Constructor

Public Sub serialize(source As Variant, target As JsonObject)
Serializes a VoltScript value into a JSON object.
idx	Argument	Data Type	Attributes	Comments
1	source	Variant		VoltScript object from which to serialize
2	target	JsonObject		JsonObject to write value to

Throws Exceptions
Message	Error Code	Comments
Not Implemented	1501

Public Class AbstractJsonConverter