Reading JSON from a String:

The second paramter hints Spin to use the JSON data format for parsing the JSON.

Alternatively, you can directly use the JSON(…) function:

import static org.camunda.spin.Spin.*;
SpinJsonNode json = JSON("{\"customer\": \"Kermit\"}");

String values that represent JSON primitive values can also be read. For example, JSON("true") returns a SpinJsonNode that represents the boolean value true.

Reading JSON from a Reader:

Spin also supports reading JSON from an instance of java.io.Reader:

import static org.camunda.spin.Spin.*;
import static org.camunda.spin.DataFormats.*;
SpinJsonNode json = S(reader, json());

The JSON(…) method also supports readers. The following example shows how to read JSON from a file (error handling ommitted):

import static org.camunda.spin.Spin.*;
FileInputStream fis = new FileInputStream("/tmp/customer.json");
InputStreamReader reader = new InputStreamReader(fis, "utf-8");
SpinJsonNode json = JSON(reader);

Reading JSON using a Script Language

JSON can be read from script languages in the same way as from Java. Since script languages use dynamic typing, you do not need to hint the data format but you can use autodetection. The following example demonstrates how to read JSON in Javascript:

var customer = S('{"customer": "Kermit"}');

Reading JSON Properties

To fetch properties from the JSON tree you can use .prop("name"). This will return the property as SpinJsonNode and you can use this to get the value of the property as the following examples will demonstrate:

in Java:

import static org.camunda.spin.Spin.*;
SpinJsonNode json = JSON("{\"customer\": \"Kermit\"}");
SpinJsonNode customerProperty = json.prop("customer");
String customerName = customerProperty.stringValue();

in Javascript:

The method SpinJsonNode#value() can be used to get the Java equivalent of a String/Boolean/Number or null JSON property. It throws an exception for Object and Array properties. There are also:

• stringValue() - gets a Java String representation of the value or throws an exception if the value is not a String

• numberValue() - gets a Java Number representation of the value or throws an exception if the value is not a Number

• boolValue() - gets a Java Boolean representation of the value or throws an exception if the value is not a Boolean

  Value type checks of the property

• isObject() returns boolean

• hasProp() returns boolean
• isBoolean() returns boolean
• isNumber() returns boolean
• isString() returns boolean
• isNull() returns boolean
• isArray() returns boolean
  Script example (JavaScript):

var json = S('{"over18":false}');
json.prop('over18').isBoolean() //returns true

You can also fetch a list of items if your property is an array of data.

import static org.camunda.spin.Spin.*;
SpinJsonNode customerProperty = json.prop("customer");
SpinList customers = customerProperty.elements();
SpinJsonNode customer = customers.get(0);
String customerName = customer.stringValue();

in Javascript:

var json = S('{"customer": ["Kermit", "Waldo"]}');
var customerProperty = json.prop("customer");
var customers = customerProperty.elements();
var customer = customers.get(0)
var customerName = customer.value();

Fetch Field Names

Spin allows us to use the .fieldNames() method to fetch the names of all child nodes and properties in a node. The following example shows you how to use .fieldNames() in Java and Javascript.

in Java:

import static org.camunda.spin.Spin.*;
SpinJsonNode json = JSON("{\"customer\": \[\"Kermit\", \"Waldo\"\]}");
ArrayList fieldNames = json.fieldNames();
String fieldName1 = fieldNames.get(0)

in Javascript:

var json = S('{"customer": ["Kermit", "Waldo"]}');
var fieldNames = json.fieldNames();
var fieldName1 = fieldNames.get(0)

Set JSON Properties

To set a property you can use the .prop("name", object) method. This allows you to set one of the following 5 simple types:

• String - Example: .prop("name", "Waldo")
• Integer - Example: .prop("age", 42)
• Long - Example: .prop("period", 4200000000)
• Float - Example: .prop("price", 42.00)

• Boolean - Example: .prop("active", true)
  or one of the 2 following container types:

• Array - Could contain a number of simple and container types

Example in Java:

import static org.camunda.spin.Spin.*;

SpinJsonNode json = JSON("{\"customer\": [\"Kermit\", \"Waldo\"]}");
ArrayList

Remove JSON Properties

There are 2 ways to remove properties from a JSON object.

• .deleteProp("name") - Removes a property with given name.
• .deleteProp() - Removes one or more properties with given names.
  For more details see the following examples for Javascript and Java.

Java:

Javascript:

var json = S('{"customer": ["Kermit", "Waldo"], "language": "en"}');
var list = ["customer", "en"];
// removes only the customer property
json.deleteProp("customer");
// removes customer and language
json.deleteProp(list);

Work with JSON Arrays

JSON arrays represent a list of objects. Spin offers the following methods to manipulate this list:

• .indexOf(
  These methods allow us to work with JSON arrays in a fast way. To show this, we will use the following JSON Object as an example:

{
  "test-array" : [
    "testdata1",
    1,
    2,
    true,
    1,
    false,
    1
  ]
}

So let’s see how we can manipulate this list in some examples.

import static org.camunda.spin.Spin.*;
SpinJsonNode json = JSON("{\"test-array\" : [\"testdata1\",\"testdata2\",1,2,true,1,false,1]}");
SpinJsonNode list = json.prop("test-array");
Integer i = list.indexOf("testdata2"); // Should be '1'
Integer j = list.lastIndexOf(1); // Should be '7'

var json = S('{"test-array" : ["testdata1","testdata2",1,2,true,1,false,1]}');
var list = json.prop("test-array");
var i = list.indexOf("testdata2"); // should be 1
var j = list.lastIndexOf(1); // Should be '7'

Example 2 - Add and Remove Data to/from the list:

import static org.camunda.spin.Spin.*;
SpinJsonNode json = JSON("{\"test-array\" : [\"testdata1\",\"testdata2\",1,2,true,1,false,1]}");
SpinJsonNode list = json.prop("test-array");
list.append("test2"); // at the end of the list there should now be "test2"
list.remove("test2"); // Aaaand now, it is gone ;)
list.insertAt(1, "test3"); // test3 should now be inserted before testdata2
list.removeAt(1, "test3"); // Aaaand now, it is gone ;)