com.hyfinity.utils

Class JSONUtils

java.lang.Object

com.hyfinity.utils.JSONUtils

public final class JSONUtils
extends java.lang.Object

Utility functions for converting between JSON strings and XML representations. These functions can be easily used within a Java Method in the studio. This makes use of the JSON Java library originally from http://www.json.org/java/ but now maintained at https://github.com/stleary/JSON-java We have modified this library to improve XML attribute handling, and to try and maintain ordering

Version:

1.0

Author:

Hyfinity Ltd. Copyright (c) 2013

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Node	jsonObjectToXml(JSONObject jo) Converts the provide JSONObject into an XML DOM Node representing the same data.
static org.w3c.dom.Node	jsonObjectToXml(JSONObject jo, boolean ignoreNamespaces) Converts the provide JSONObject into an XML DOM Node representing the same data.
static org.w3c.dom.Node	jsonToXml(java.lang.String json) Converts the provide JSON string into an XML DOM Node representing the same data.
static java.lang.String	xmlToJson(org.w3c.dom.Node xml) Converts the provide XML node into a JSON string representation of the same data.
static JSONObject	xmlToJsonObject(org.w3c.dom.Node xml) Converts the provided XML node into a JSONObject representation of the same data.
static JSONObject	xmlToJsonObject(org.w3c.dom.Node xml, boolean ignoreNamespaces) Converts the provided XML node into a JSONObject representation of the same data.

Methods inherited from class java.lang.Object

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

Method Detail

xmlToJson

public static java.lang.String xmlToJson(org.w3c.dom.Node xml)
                                  throws java.io.IOException

Converts the provide XML node into a JSON string representation of the same data.

Parameters:

xml - The DOM Node containing the information to output as JSON.

Returns:

The created JSON String.

Throws:

java.io.IOException - if problem encountered trying to serialize the XML.

xmlToJsonObject

public static JSONObject xmlToJsonObject(org.w3c.dom.Node xml)
                                  throws java.io.IOException

Converts the provided XML node into a JSONObject representation of the same data. This method WILL include @xmlns entries in the result where applicable.

Parameters:

xml - The DOM Node containing the information to output as JSON.

Returns:

The created JSONObject.

Throws:

java.io.IOException - if problem encountered trying to serialize the XML.

xmlToJsonObject

public static JSONObject xmlToJsonObject(org.w3c.dom.Node xml,
                                         boolean ignoreNamespaces)
                                  throws java.io.IOException

Converts the provided XML node into a JSONObject representation of the same data.

Parameters:

xml - The DOM Node containing the information to output as JSON.

ignoreNamespaces - If true, no namespace details will be included in the resulting json object.

Returns:

The created JSONObject.

Throws:

java.io.IOException - if problem encountered trying to serialize the XML.

jsonToXml

public static org.w3c.dom.Node jsonToXml(java.lang.String json)

Converts the provide JSON string into an XML DOM Node representing the same data.

Parameters:

json - The JSON String to convert into an XML structure.

Returns:

The XML DOM Node.

jsonObjectToXml

public static org.w3c.dom.Node jsonObjectToXml(JSONObject jo)

Converts the provide JSONObject into an XML DOM Node representing the same data.

Parameters:

jo - The JSONObject to convert into an XML structure.

Returns:

The XML DOM Node.

jsonObjectToXml

public static org.w3c.dom.Node jsonObjectToXml(JSONObject jo,
                                               boolean ignoreNamespaces)

Converts the provide JSONObject into an XML DOM Node representing the same data.

Parameters:

jo - The JSONObject to convert into an XML structure.

ignoreNamespaces - If true, no namespace definitions will be included in the resulting XML.

Returns:

The XML DOM Node.