net.razorvine.serpent

Class Serializer

java.lang.Object

net.razorvine.serpent.Serializer

public class Serializer
extends Object

Serialize an object tree to a byte stream. It is not thread-safe: make sure you're not making changes to the object tree that is being serialized.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	indent Indent the resulting serpent serialization text?
int	maximumLevel The maximum nesting level of the object graphs that you want to serialize.
boolean	packageInClassName Include package name in class name, for classes that are serialized to dicts?
boolean	setliterals Use set literals?

Constructor Summary

Constructors

Constructor and Description
Serializer() Create a Serpent serializer with default options.
Serializer(boolean indent, boolean setliterals, boolean packageInClassName) Create a Serpent serializer with custom options.

Method Summary

Modifier and Type	Method and Description
protected Object	convertJythonObject(Object obj) When used from Jython directly, it sometimes passes some Jython specific classes to the serializer (such as org.python.core.PyComplex for a complex number).
protected IClassSerializer	getCustomConverter(Class<?> type)
protected boolean	isBoxed(Class<?> type)
static void	registerClass(Class<?> clazz, IClassSerializer converter) Register a custom class serializer, if you want to tweak the serialization of classes that Serpent doesn't know about yet.
protected void	serialize_bigdecimal(BigDecimal decimal, StringWriter sw, int level)
protected void	serialize_bytes(byte[] obj, StringWriter sw, int level)
protected void	serialize_calendar(Calendar cal, StringWriter sw, int level)
protected void	serialize_class(Object obj, StringWriter sw, int level)
protected void	serialize_collection(Collection<?> collection, StringWriter sw, int level)
protected void	serialize_complex(ComplexNumber cplx, StringWriter sw, int level)
protected void	serialize_date(Date date, StringWriter sw, int level)
protected void	serialize_dict(Map<?,?> dict, StringWriter sw, int level)
protected void	serialize_exception(Exception ex, StringWriter sw, int level)
protected void	serialize_primitive_array(Object array, StringWriter sw, int level)
protected void	serialize_primitive(Object obj, StringWriter sw, int level)
protected void	serialize_sequence_elements(Collection<?> elts, boolean trailingComma, StringWriter sw, int level)
protected void	serialize_set(Set<?> set, StringWriter sw, int level)
protected void	serialize_string(String str, StringWriter sw, int level)
protected void	serialize_tuple(Collection<?> items, StringWriter sw, int level)
protected void	serialize_uuid(UUID obj, StringWriter sw, int level)
byte[]	serialize(Object obj) Serialize an object graph to a serpent serialized form.
protected void	serialize(Object obj, StringWriter sw, int level)

Methods inherited from class java.lang.Object

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

Field Detail

maximumLevel

public int maximumLevel

The maximum nesting level of the object graphs that you want to serialize. This limit has been set to avoid troublesome stack overflow errors. (If it is reached, an IllegalArgumentException is thrown instead with a clear message)

indent

public boolean indent

Indent the resulting serpent serialization text?

setliterals

public boolean setliterals

Use set literals?

packageInClassName

public boolean packageInClassName

Include package name in class name, for classes that are serialized to dicts?

Constructor Detail

Serializer

public Serializer()

Create a Serpent serializer with default options.

Serializer

public Serializer(boolean indent,
                  boolean setliterals,
                  boolean packageInClassName)

Create a Serpent serializer with custom options.

Parameters:

indent - should the output be indented to make it more readable?

setliterals - should set literals be used (recommended if you use newer Python versions to parse this)

packageInClassName - should the package name be included with the class name for classes that are serialized to dict?

Method Detail

registerClass

public static void registerClass(Class<?> clazz,
                                 IClassSerializer converter)

Register a custom class serializer, if you want to tweak the serialization of classes that Serpent doesn't know about yet.

serialize

public byte[] serialize(Object obj)

Serialize an object graph to a serpent serialized form.

serialize

protected void serialize(Object obj,
                         StringWriter sw,
                         int level)

convertJythonObject

protected Object convertJythonObject(Object obj)

When used from Jython directly, it sometimes passes some Jython specific classes to the serializer (such as org.python.core.PyComplex for a complex number). Due to the way these are constructed, Serpent is greatly confused, and will often end up in an endless loop eventually crashing with too deep nesting. For the know cases, we convert them here to appropriate representations.

serialize_collection

protected void serialize_collection(Collection<?> collection,
                                    StringWriter sw,
                                    int level)

serialize_sequence_elements

protected void serialize_sequence_elements(Collection<?> elts,
                                           boolean trailingComma,
                                           StringWriter sw,
                                           int level)

serialize_set

protected void serialize_set(Set<?> set,
                             StringWriter sw,
                             int level)

serialize_primitive_array

protected void serialize_primitive_array(Object array,
                                         StringWriter sw,
                                         int level)

serialize_tuple

protected void serialize_tuple(Collection<?> items,
                               StringWriter sw,
                               int level)

serialize_bytes

protected void serialize_bytes(byte[] obj,
                               StringWriter sw,
                               int level)

serialize_dict

protected void serialize_dict(Map<?,?> dict,
                              StringWriter sw,
                              int level)

serialize_calendar

protected void serialize_calendar(Calendar cal,
                                  StringWriter sw,
                                  int level)

serialize_date

protected void serialize_date(Date date,
                              StringWriter sw,
                              int level)

serialize_complex

protected void serialize_complex(ComplexNumber cplx,
                                 StringWriter sw,
                                 int level)

serialize_uuid

protected void serialize_uuid(UUID obj,
                              StringWriter sw,
                              int level)

serialize_bigdecimal

protected void serialize_bigdecimal(BigDecimal decimal,
                                    StringWriter sw,
                                    int level)

isBoxed

protected boolean isBoxed(Class<?> type)

serialize_class

protected void serialize_class(Object obj,
                               StringWriter sw,
                               int level)

getCustomConverter

protected IClassSerializer getCustomConverter(Class<?> type)

serialize_primitive

protected void serialize_primitive(Object obj,
                                   StringWriter sw,
                                   int level)

serialize_string

protected void serialize_string(String str,
                                StringWriter sw,
                                int level)

serialize_exception

protected void serialize_exception(Exception ex,
                                   StringWriter sw,
                                   int level)