org.rapidcontext.core.js

Class JsSerializer

java.lang.Object

org.rapidcontext.core.js.JsSerializer

public class JsSerializer
extends java.lang.Object

An object serializer and unserializer for the JavaScript object notation (JSON) format. This class also provides methods for wrapping dictionary and array object for access inside the JavaScript engine. The object mapping to JavaScript is not exact, and may omit serialization of data in some cases. The following basic requirements must be met in order to serialize an object:

• No circular references are permitted.
• String, Integer, Boolean, Array or Dict objects are supported.

Version:

1.0

Author:

Per Cederberg

Constructor Summary

Constructors

Constructor and Description
JsSerializer()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	serialize(java.lang.Object obj, boolean indent) Serializes an object into a JavaScript literal (JSON).
static java.lang.Object	unserialize(java.lang.String str) Unserializes a JavaScript literal into a Java object.
static java.lang.Object	unwrap(java.lang.Object obj) Removes all JavaScript classes and replaces them with the corresponding Java objects.
static java.lang.Object	wrap(java.lang.Object obj, org.mozilla.javascript.Scriptable scope) Wraps a Java object for JavaScript access.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsSerializer

public JsSerializer()

Method Detail

serialize

public static java.lang.String serialize(java.lang.Object obj,
                                         boolean indent)

Serializes an object into a JavaScript literal (JSON). The string returned can be used as a constant inside JavaScript code or returned via a JSON API. If the indentation flag is set, the JSON data will be indented and formatted. Otherwise a minimal string will be returned.

Parameters:

obj - the object to convert, or null

indent - the indentation flag

Returns:

a JavaScript literal

unserialize

public static java.lang.Object unserialize(java.lang.String str)
                                    throws JsException

Unserializes a JavaScript literal into a Java object. I.e. this method converts a JSON object into the corresponding String, Number, Boolean, Dict and/or Array objects.

Parameters:

str - the string to convert, or null

Returns:

the corresponding Java object

Throws:

JsException - if the unserialization failed

wrap

public static java.lang.Object wrap(java.lang.Object obj,
                                    org.mozilla.javascript.Scriptable scope)

Wraps a Java object for JavaScript access. This method only handles String, Number, Boolean and Data instances.

Parameters:

obj - the object to wrap

scope - the parent scope

Returns:

the wrapped object

See Also:

Array, Dict

unwrap

public static java.lang.Object unwrap(java.lang.Object obj)

Removes all JavaScript classes and replaces them with the corresponding Java objects. This method will use instances of Dict and Array to replace native JavaScript objects and arrays. Also, it will replace both JavaScript "null" and "undefined" with null. Any Dict or Array object encountered will be traversed and copied recursively. Other objects will be returned as-is.

Parameters:

obj - the object to unwrap

Returns:

the unwrapped object

See Also:

Array, Dict