org.mozilla.javascript.serialize

Class ScriptableOutputStream

public class ScriptableOutputStream extends ObjectOutputStream

Class ScriptableOutputStream is an ObjectOutputStream used to serialize JavaScript objects and functions. Note that compiled functions currently cannot be serialized, only interpreted functions. The top-level scope containing the object is not written out, but is instead replaced with another top-level object when the ScriptableInputStream reads in this object. Also, object corresponding to names added to the exclude list are not written out but instead are looked up during deserialization. This approach avoids the creation of duplicate copies of standard objects during deserialization.

Author: Norris Boyd

Constructor Summary
ScriptableOutputStream(OutputStream out, Scriptable scope)
ScriptableOutputStream constructor.
Method Summary
voidaddExcludedName(String name)
Adds a qualified name to the list of object to be excluded from serialization.
voidaddOptionalExcludedName(String name)
Adds a qualified name to the list of object to be excluded from serialization.
voidexcludeStandardObjectNames()
Adds the names of the standard objects and their prototypes to the list of excluded names.
booleanhasExcludedName(String name)
Returns true if the name is excluded from serialization.
voidremoveExcludedName(String name)
Removes a name from the list of names to exclude.
protected ObjectreplaceObject(Object obj)

Constructor Detail

ScriptableOutputStream

public ScriptableOutputStream(OutputStream out, Scriptable scope)
ScriptableOutputStream constructor. Creates a ScriptableOutputStream for use in serializing JavaScript objects. Calls excludeStandardObjectNames.

Parameters: out the OutputStream to write to. scope the scope containing the object.

Method Detail

addExcludedName

public void addExcludedName(String name)
Adds a qualified name to the list of object to be excluded from serialization. Names excluded from serialization are looked up in the new scope and replaced upon deserialization.

Parameters: name a fully qualified name (of the form "a.b.c", where "a" must be a property of the top-level object)

Throws: IllegalArgumentException if the object is not found or is not a Scriptable.

addOptionalExcludedName

public void addOptionalExcludedName(String name)
Adds a qualified name to the list of object to be excluded from serialization. Names excluded from serialization are looked up in the new scope and replaced upon deserialization.

Parameters: name a fully qualified name (of the form "a.b.c", where "a" must be a property of the top-level object). The object need not exist, in which case the name is ignored.

Throws: IllegalArgumentException if the object is not a Scriptable.

excludeStandardObjectNames

public void excludeStandardObjectNames()
Adds the names of the standard objects and their prototypes to the list of excluded names.

hasExcludedName

public boolean hasExcludedName(String name)
Returns true if the name is excluded from serialization.

removeExcludedName

public void removeExcludedName(String name)
Removes a name from the list of names to exclude.

replaceObject

protected Object replaceObject(Object obj)