org.xwiki.velocity.tools

Class JSONTool

java.lang.Object

org.xwiki.velocity.tools.JSONTool

public class JSONTool
extends Object

Velocity tool to facilitate serialization of Java objects to the JSON format.

Since:

4.0M2

Version:

$Id: 93cbaf677d0b951510a9086fb16f98b976a90b1f $

Constructor Summary

Constructors

Constructor and Description
JSONTool()

Method Summary

Modifier and Type	Method and Description
net.sf.json.JSON	parse(String json) Deprecated. use parseToJSONArray(String)} or parseToJSONObject(String) instead
org.json.JSONArray	parseToJSONArray(String json) Parse a serialized JSON into a real JSONArray.
org.json.JSONObject	parseToJSONObject(String json) Parse a serialized JSON into a real JSONObject.
String	serialize(Object object) Serialize a Java object to the JSON format.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONTool

public JSONTool()

Method Detail

serialize

public String serialize(Object object)

Serialize a Java object to the JSON format.

Examples:

• numbers and boolean values: 23, 13.5, true, false
• strings: "one\"two'three" (quotes included)
• arrays and collections: [1, 2, 3]
• maps: {"number": 23, "boolean": false, "string": "value"}
• beans: {"enabled": true, "name": "XWiki"} for a bean that has #isEnabled() and #getName() getters

Parameters:

object - the object to be serialized to the JSON format

Returns:

the JSON-verified string representation of the given object

parse

@Deprecated
public net.sf.json.JSON parse(String json)

Deprecated. use parseToJSONArray(String)} or parseToJSONObject(String) instead

Parse a serialized JSON into a real JSON object. Only valid JSON strings can be parsed, and doesn't support JSONP. If the argument is not valid JSON, then null is returned.

Parameters:

json - the string to parse, must be valid JSON

Returns:

the parsed JSON, either a JSONObject or a JSONArray, or null if the argument is not a valid JSON

Since:

5.2M1

parseToJSONObject

public org.json.JSONObject parseToJSONObject(String json)

Parse a serialized JSON into a real JSONObject. Only valid strings can be parsed, and doesn't support JSONP. If the argument is not valid JSON, then null is returned.

Parameters:

json - the string to parse, must be valid JSON

Returns:

the parsed JSON Object, or null if the argument is not a valid JSON

Since:

1.3M4

parseToJSONArray

public org.json.JSONArray parseToJSONArray(String json)

Parse a serialized JSON into a real JSONArray. Only valid strings can be parsed, and doesn't support JSONP. If the argument is not valid JSON, then null is returned.

Parameters:

json - the string to parse, must be valid JSON

Returns:

the parsed JSON Array, or null if the argument is not a valid JSON array

Since:

1.3M4