parse

parse(json:           String;
      type:           Class;
      createdObjects: ObjectArray input): Object;

The parse method of the JadeJson class parses JSON text to create and populate an object and all referenced objects.

The parse method parameters are the:

json parameter specifies the source string to parse in Microsoft or NewtonSoft format. Parser handles both formats without needing to know the type of the JSON.
type parameter specifies the object type of the data. If the JSON text includes a type tag, the type tag must be the same as the class specified in this parameter or a subclass of the specified class. An object of that type is created and populated. If the JSON does not include a type tag, an object of the class specified in the type parameter is created and populated.

By default, the parse method does not modify read‑only and protected properties of the object type of the data class that is being created. Set the value of the modifyReadOnlyProperties property to true if you want read‑only properties to be populated with their values from the JSON text.
createdObjects parameter specifies a transient object array supplied by the caller. All objects created are added to the array (the array is not cleared by the method). It is the responsibility of the caller to delete all objects returned from the method.

The return value is the object created from the parsed JSON string together with any referenced objects. It is the first object added to the array specified in the createdObjects parameter. The return value is null if the JSON contains null or is empty.

An exception is generated if the text cannot be parsed successfully.

If any object that would be created has a constructor method with parameters, exception 1188 (Constructor not called) is raised. To create an instance of a class that has a constructor method with parameters, the recommended approach is to create a proxy object (without a constructor method) which is then converted to the required object.

JSON text does not necessarily include a tag indicating the type of the data. If the JSON does not include a type tag, the JSON parser must assume that the data is of the correct type. Any properties not found on the class of any object are ignored and no error is raised. If the JSON text does not match the expected type, it could be because no property values are set on the created object or that the data does not match the property type.

The format type represented by the:

Format_Json_Microsoft class constant rejects an object where an object is referenced more than once in the object tree (Microsoft JSON handling does not handle that situation).
Format_Json_Newton class constant assigns a unique tag to each object, allowing multiple and circular references to be handled so that each object is included once only and subsequent references use the assigned tag for identification.

The following is a Microsoft example.

{"_type":"Customer","name":"smith","sex":"M", 
"description":"","ignore":false,"image":[]}

The following is a NewtonSoft example that shows an object with a type tag and an object identifier.

{"$type":"Customer","$id":"Customer4294967297","name":"Smith","bin":[],"description":"","ignore":false,"image":[]}

The following is an example of an array in the JSONN (NewtonSoft JSON) format.

1 {"$id":"ArrayOfInteger1", "$values":[1,2,3]}

In this example, the "$id" tag can be anything but it is unique for each array in the JSON string. You can use the $ref tag to reference already existing objects by array identifier. The "$values" tag contains all of the values for the array. The "$id" tag must come before the "$values" tag, the "$id" tag must have a string value, and the "$values" tag must be a square-bracketed ([ ]) array or it will not parse successfully and an exception will be returned.

The JSON for the description of each object includes the type of the object in the text.

2016.0.01 and higher