com.soa.json.xml.script

Class XML2JSON

java.lang.Object

com.soa.json.xml.script.XML2JSON

public class XML2JSON
extends java.lang.Object

Utility for converting XML to JSON.

To obtain a converter from a script use:

converter = XML2JSON.converter();

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(java.lang.String xml) Converts an XML string to a JSON string.
static XML2JSON	converter() Returns a XML2JSON converter.
void	setArrayElements(java.lang.String[] elements) Without direction JSON arrays are found by inspecting an XML element's children to see if there are more than one and if they are the same element type based on name.
void	setForceTopLevelObject(boolean force) Indicates whether the root XML element should be a named JSON object inside an outer set of {}'s or treated anonymously as the root JSON object represented with the outer {}'s.
void	setIgnoreNamespaces(boolean ignore) Indicates whether namespace declarations should be converted to JSON attributes or not (ignored entirely).
void	setRemoveNamespacePrefixes(boolean remove) Indicates whether namespace prefixes in XML element names should be removed when generating JSON names or not.

Methods inherited from class java.lang.Object

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

Method Detail

converter

public static XML2JSON converter()

Returns a XML2JSON converter.

Returns:

XML2JSON converter.

convert

public java.lang.String convert(java.lang.String xml)

Converts an XML string to a JSON string.

Parameters:

xml - XML string.

Returns:

JSON string.

setRemoveNamespacePrefixes

public void setRemoveNamespacePrefixes(boolean remove)

Indicates whether namespace prefixes in XML element names should be removed when generating JSON names or not. The default is false.

Parameters:

remove - True if prefixes should be removed, false if not.

setIgnoreNamespaces

public void setIgnoreNamespaces(boolean ignore)

Indicates whether namespace declarations should be converted to JSON attributes or not (ignored entirely). The default is false.

Parameters:

ignore - True if namespace declarations should be ignored, false if they should be converted to attributes.

setForceTopLevelObject

public void setForceTopLevelObject(boolean force)

Indicates whether the root XML element should be a named JSON object inside an outer set of {}'s or treated anonymously as the root JSON object represented with the outer {}'s. For example, if true the XML string 1 will become { "a" : { "b": 1 } }. If false the same XML string will become { "b": 1 }. The default is false.

Parameters:

force - True to include the top level XML as a named JSON object, false to treat the root XML element anonymously.

setArrayElements

public void setArrayElements(java.lang.String[] elements)

Without direction JSON arrays are found by inspecting an XML element's children to see if there are more than one and if they are the same element type based on name. If there is only one child element though as an example, the serializer will have to conclude that the element is not an array. To avoid relying on the serializer to make this decision a list of XML element (local) names can be provided that the serializer should always treat as JSON arrays regardless of their content.

Parameters:

elements - list of XML element (local part) names.