org.ballerinalang.model.util

Class JSONUtils

java.lang.Object

org.ballerinalang.model.util.JSONUtils

public class JSONUtils
extends Object

Common utility methods used for JSON manipulation.

Since:

0.87

Constructor Summary

Constructors

Constructor and Description
JSONUtils()

Method Summary

Modifier and Type	Method and Description
static BJSON	convertArrayToJSON(BBooleanArray booleanArray) Convert BBooleanArray to BJSON.
static BJSON	convertArrayToJSON(BFloatArray floatArray) Convert BFloatArray to BJSON.
static BJSON	convertArrayToJSON(BIntArray intArray) Convert BIntArray to BJSON.
static BJSON	convertArrayToJSON(BNewArray bArray) Convert BNewArray to BJSON.
static BJSON	convertArrayToJSON(BRefValueArray refValueArray) Convert BRefValueArray to BJSON.
static BJSON	convertArrayToJSON(BStringArray stringArray) Convert BStringArray to BJSON.
static BStruct	convertJSONNodeToStruct(JsonNode jsonNode, BStructType structType) Convert a BJSON to a user defined struct.
static BStruct	convertJSONToStruct(BJSON bjson, BStructType structType) Convert a BJSON to a user defined struct.
static BJSON	convertMapToJSON(BMap<String,BValue> map) Convert BMap to BJSON.
static BJSON	convertStructToJSON(BStruct struct) Convert BStruct to BJSON.
static BJSON	convertStructToJSON(BStruct struct, BJSONType targetType) Convert BStruct to BJSON.
static BXML	convertToXML(BJSON json, String attributePrefix, String arrayEntryTag) Converts given json object to the corresponding xml.
static BRefType<?>	convertUnionTypeToJSON(BRefType<?> source)
static BJSON	getArrayElement(BJSON json, long index) Get an element from a JSON array.
static BJSON	getElement(BJSON json, String elementName) Get an element from a JSON.
static int	getJSONArrayLength(BJSON json) Returns the size of JSON Array.
static BStringArray	getKeys(BJSON json) Returns the keys of a JSON as a BStringArray.
static String	getTypeName(JsonNode jsonValue)
static boolean	hasElement(BJSON json, String elementName) Check whether JSON has particular field.
static boolean	isJSONArray(BJSON json) Check whether provided JSON object is a JSON Array.
static void	remove(BJSON json, String fieldName) Remove a field from JSON.
static void	setArrayElement(BJSON json, long index, BJSON element) Set an element in the given position of a JSON array.
static void	setElement(BJSON json, String elementName, BJSON element) Set an element in a JSON.
static BJSON	toJSON(BTable table, boolean isInTransaction) Convert BTable to BJSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONUtils

public JSONUtils()

Method Detail

hasElement

public static boolean hasElement(BJSON json,
                                 String elementName)

Check whether JSON has particular field.

Parameters:

json - JSON to be considered.

elementName - String name json field to be considered.

Returns:

Boolean 'true' if JSON has given field.

convertMapToJSON

public static BJSON convertMapToJSON(BMap<String,BValue> map)

Convert BMap to BJSON.

Parameters:

map - BMap to be converted to BJSON

Returns:

JSON representation of the provided map

convertArrayToJSON

public static BJSON convertArrayToJSON(BIntArray intArray)

Convert BIntArray to BJSON.

Parameters:

intArray - BIntArray to be converted to BJSON

Returns:

JSON representation of the provided intArray

convertArrayToJSON

public static BJSON convertArrayToJSON(BFloatArray floatArray)

Convert BFloatArray to BJSON.

Parameters:

floatArray - BFloatArray to be converted to BJSON

Returns:

JSON representation of the provided floatArray

convertArrayToJSON

public static BJSON convertArrayToJSON(BStringArray stringArray)

Convert BStringArray to BJSON.

Parameters:

stringArray - BStringArray to be converted to BJSON

Returns:

JSON representation of the provided stringArray

convertArrayToJSON

public static BJSON convertArrayToJSON(BBooleanArray booleanArray)

Convert BBooleanArray to BJSON.

Parameters:

booleanArray - BBooleanArray to be converted to BJSON

Returns:

JSON representation of the provided booleanArray

convertArrayToJSON

public static BJSON convertArrayToJSON(BNewArray bArray)

Convert BNewArray to BJSON.

Parameters:

bArray - BNewArray to be converted to BJSON

Returns:

JSON representation of the provided bArray

convertArrayToJSON

public static BJSON convertArrayToJSON(BRefValueArray refValueArray)

Convert BRefValueArray to BJSON.

Parameters:

refValueArray - BRefValueArray to be converted to BJSON

Returns:

JSON representation of the provided refValueArray

convertStructToJSON

public static BJSON convertStructToJSON(BStruct struct)

Convert BStruct to BJSON.

Parameters:

struct - BStruct to be converted to BJSON

Returns:

JSON representation of the provided array

convertStructToJSON

public static BJSON convertStructToJSON(BStruct struct,
                                        BJSONType targetType)

Convert BStruct to BJSON.

Parameters:

struct - BStruct to be converted to BJSON

targetType - the target JSON type to be convert to

Returns:

JSON representation of the provided array

toJSON

public static BJSON toJSON(BTable table,
                           boolean isInTransaction)

Convert BTable to BJSON.

Parameters:

table - BTable to be converted to BJSON

isInTransaction - Within a transaction or not

Returns:

JSON representation of the provided table

getElement

public static BJSON getElement(BJSON json,
                               String elementName)

Get an element from a JSON.

Parameters:

json - JSON object to get the element from

elementName - Name of the element to be retrieved

Returns:

Element of JSON having the provided name, if the JSON is object type. Null otherwise.

setElement

public static void setElement(BJSON json,
                              String elementName,
                              BJSON element)

Set an element in a JSON. If an element with the given name already exists, this method will update the existing element. Otherwise, a new element with the given name will be added. If the JSON is not object type, then this operation has no effect.

Parameters:

json - JSON object to set the element

elementName - Name of the element to be set

element - JSON element

isJSONArray

public static boolean isJSONArray(BJSON json)

Check whether provided JSON object is a JSON Array.

Parameters:

json - JSON to execute array condition.

Returns:

returns true if provided JSON is a JSON Array.

getJSONArrayLength

public static int getJSONArrayLength(BJSON json)

Returns the size of JSON Array.

Parameters:

json - JSON to calculate array size.

Returns:

returns integer that represents size of JSON Array.

getArrayElement

public static BJSON getArrayElement(BJSON json,
                                    long index)

Get an element from a JSON array.

Parameters:

json - JSON array to get the element from

index - Index of the element needed

Returns:

Element at the given index, if the provided JSON is an array. Null, otherwise.

setArrayElement

public static void setArrayElement(BJSON json,
                                   long index,
                                   BJSON element)

Set an element in the given position of a JSON array. This method will update the existing value. If the JSON is not array type, then this operation has no effect.

Parameters:

json - JSON array to set the element

index - Index of the element to be set

element - Element to be set

convertToXML

public static BXML convertToXML(BJSON json,
                                String attributePrefix,
                                String arrayEntryTag)

Converts given json object to the corresponding xml.

Parameters:

json - JSON object to get the corresponding xml

attributePrefix - String prefix used for attributes

arrayEntryTag - String used as the tag in the arrays

Returns:

BXML XML representation of the given json object

convertJSONToStruct

public static BStruct convertJSONToStruct(BJSON bjson,
                                          BStructType structType)

Convert a BJSON to a user defined struct.

Parameters:

bjson - JSON to convert

structType - Type (definition) of the target struct

Returns:

If the provided JSON is of object-type, this method will return a BStruct containing the values of the JSON object. Otherwise the method will throw a BallerinaException.

convertJSONNodeToStruct

public static BStruct convertJSONNodeToStruct(JsonNode jsonNode,
                                              BStructType structType)

Convert a BJSON to a user defined struct.

Parameters:

jsonNode - JSON to convert

structType - Type (definition) of the target struct

Returns:

If the provided JSON is of object-type, this method will return a BStruct containing the values of the JSON object. Otherwise the method will throw a BallerinaException.

getKeys

public static BStringArray getKeys(BJSON json)

Returns the keys of a JSON as a BStringArray.

Parameters:

json - BJSON to get the keys

Returns:

Keys of the JSON as a BStringArray

convertUnionTypeToJSON

public static BRefType<?> convertUnionTypeToJSON(BRefType<?> source)

remove

public static void remove(BJSON json,
                          String fieldName)

Remove a field from JSON. Has no effect if the JSON if not object types or if the given field doesn't exists.

Parameters:

json - JSON object

fieldName - Name of the field to remove

getTypeName

public static String getTypeName(JsonNode jsonValue)