net.razorvine.pickle

Class Unpickler

java.lang.Object

net.razorvine.pickle.Unpickler

public class Unpickler
extends Object

Unpickles an object graph from a pickle data inputstream. Supports all pickle protocol versions. Maps the python objects on the corresponding java equivalents or similar types. This class is NOT threadsafe! (Don't use the same pickler from different threads) See the README.txt for a table of the type mappings.

Author:

Irmen de Jong (irmen@razorvine.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected UnpickleStack	stack

Constructor Summary

Constructors

Constructor and Description
Unpickler() Create an unpickler.

Method Summary

Modifier and Type	Method and Description
void	close() Close the unpickler and frees the resources such as the unpickle stack and memo table.
protected void	dispatch(short key) Process a single pickle stream opcode.
Object	load(InputStream stream) Read a pickled object representation from the given input stream.
Object	loads(byte[] pickledata) Read a pickled object representation from the given pickle data bytes.
static void	registerConstructor(String module, String classname, IObjectConstructor constructor) Register additional object constructors for custom classes.

Methods inherited from class java.lang.Object

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

Field Detail

stack

protected UnpickleStack stack

Constructor Detail

Unpickler

public Unpickler()

Create an unpickler.

Method Detail

registerConstructor

public static void registerConstructor(String module,
                                       String classname,
                                       IObjectConstructor constructor)

Register additional object constructors for custom classes.

load

public Object load(InputStream stream)
            throws PickleException,
                   IOException

Read a pickled object representation from the given input stream.

Returns:

the reconstituted object hierarchy specified in the file.

Throws:

PickleException

IOException

loads

public Object loads(byte[] pickledata)
             throws PickleException,
                    IOException

Read a pickled object representation from the given pickle data bytes.

Returns:

the reconstituted object hierarchy specified in the file.

Throws:

PickleException

IOException

close

public void close()

Close the unpickler and frees the resources such as the unpickle stack and memo table.

dispatch

protected void dispatch(short key)
                 throws PickleException,
                        IOException

Process a single pickle stream opcode.

Throws:

PickleException

IOException