net.razorvine.pickle

Class Pickler

java.lang.Object

net.razorvine.pickle.Pickler

public class Pickler
extends Object

Pickle an object graph into a Python-compatible pickle stream. For simplicity, the only supported pickle protocol at this time is protocol 2. This class is NOT threadsafe! (Don't use the same pickler from different threads) See the README.txt for a table with the type mappings.

Author:

Irmen de Jong (irmen@razorvine.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Pickler.Memo

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<Class<?>,IObjectPickler>	customPicklers
static int	HIGHEST_PROTOCOL
protected static int	MAX_RECURSE_DEPTH
protected HashMap<Integer,Pickler.Memo>	memo
protected OutputStream	out
protected int	PROTOCOL
protected int	recurse
protected boolean	useMemo

Constructor Summary

Constructors

Constructor and Description
Pickler() Create a Pickler.
Pickler(boolean useMemo) Create a Pickler.

Method Summary

Modifier and Type	Method and Description
void	close() Close the pickler stream, discard any internal buffers.
void	dump(Object o, OutputStream stream) Pickle a given object graph, writing the result to the output stream.
byte[]	dumps(Object o) Pickle a given object graph, returning the result as a byte array.
protected IObjectPickler	getCustomPickler(Class<?> t)
static void	registerCustomPickler(Class<?> clazz, IObjectPickler pickler) Register additional object picklers for custom classes.
void	save(Object o) Pickle a single object and write its pickle representation to the output stream.
protected void	writeMemo(Object obj) Write the object to the memo table and output a memo write opcode Only works for hashable objects

Methods inherited from class java.lang.Object

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

Field Detail

HIGHEST_PROTOCOL

public static int HIGHEST_PROTOCOL

MAX_RECURSE_DEPTH

protected static int MAX_RECURSE_DEPTH

recurse

protected int recurse

out

protected OutputStream out

PROTOCOL

protected int PROTOCOL

customPicklers

protected static Map<Class<?>,IObjectPickler> customPicklers

useMemo

protected boolean useMemo

memo

protected HashMap<Integer,Pickler.Memo> memo

Constructor Detail

Pickler

public Pickler()

Create a Pickler.

Pickler

public Pickler(boolean useMemo)

Create a Pickler. Specify if it is to use a memo table or not. The memo table is NOT reused across different calls. If you use a memo table, you can only pickle objects that are hashable.

Method Detail

close

public void close()
           throws IOException

Close the pickler stream, discard any internal buffers.

Throws:

IOException

registerCustomPickler

public static void registerCustomPickler(Class<?> clazz,
                                         IObjectPickler pickler)

Register additional object picklers for custom classes. If you register an interface or abstract base class, it means the pickler is used for the whole inheritance tree of all classes ultimately implementing that interface or abstract base class. If you register a normal concrete class, the pickler is only used for objects of exactly that particular class.

dumps

public byte[] dumps(Object o)
             throws PickleException,
                    IOException

Pickle a given object graph, returning the result as a byte array.

Throws:

PickleException

IOException

dump

public void dump(Object o,
                 OutputStream stream)
          throws IOException,
                 PickleException

Pickle a given object graph, writing the result to the output stream.

Throws:

IOException

PickleException

save

public void save(Object o)
          throws PickleException,
                 IOException

Pickle a single object and write its pickle representation to the output stream. Normally this is used internally by the pickler, but you can also utilize it from within custom picklers. This is handy if as part of the custom pickler, you need to write a couple of normal objects such as strings or ints, that are already supported by the pickler. This method can be called recursively to output sub-objects.

Throws:

PickleException

IOException

writeMemo

protected void writeMemo(Object obj)
                  throws IOException

Write the object to the memo table and output a memo write opcode Only works for hashable objects

Throws:

IOException

getCustomPickler

protected IObjectPickler getCustomPickler(Class<?> t)