ca.uqac.lif.azrael

Class ObjectReader<T>

java.lang.Object

ca.uqac.lif.azrael.ObjectReader<T>

Type Parameters:

T - The format to which the object has been written

Direct Known Subclasses:

CloneReader, JsonReader, XmlReader

public abstract class ObjectReader<T>
extends java.lang.Object

Reads the content of an object in a given format, to recreate the corresponding instance.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.ClassLoader>	m_classLoaders Additional class loaders
protected java.util.List<ReadHandler<T>>	m_handlers A list of objects that handle the printing of objects of various types
protected ReadHandler<T>	m_reflectionHandler The default handler to use when no other accepts an object

Constructor Summary

Constructors

Constructor and Description
ObjectReader() Creates a new object reader

Method Summary

Modifier and Type	Method and Description
void	addClassLoader(java.lang.ClassLoader cl) Adds a new class loader used to create new class instances
java.lang.Class<?>	findClass(java.lang.String class_name) Finds a class by its name
java.lang.Object	getInstance(java.lang.Class<?> clazz) Produces an instance of an object based on its deserialized contents and a target class.
protected abstract boolean	isWrapped(java.lang.Object t)
java.lang.Object	read(java.lang.Object t) Deserializes the content of an object
static void	setField(java.lang.Object o, java.lang.String field_name, java.lang.Object value) Sets the value of a field in an object
protected abstract java.lang.Object	unwrapContents(java.lang.Object t)
protected abstract java.lang.Class<?>	unwrapType(java.lang.Object t)

Methods inherited from class java.lang.Object

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

Field Detail

m_classLoaders

protected java.util.Set<java.lang.ClassLoader> m_classLoaders

Additional class loaders

m_handlers

protected java.util.List<ReadHandler<T>> m_handlers

A list of objects that handle the printing of objects of various types

m_reflectionHandler

protected ReadHandler<T> m_reflectionHandler

The default handler to use when no other accepts an object

Constructor Detail

ObjectReader

public ObjectReader()

Creates a new object reader

Method Detail

read

public java.lang.Object read(java.lang.Object t)
                      throws ReadException

Deserializes the content of an object

Parameters:

t - The serialized contents of the object

Returns:

The deserialized object

Throws:

ReadException - Thrown if deserialization produced an error

unwrapType

protected abstract java.lang.Class<?> unwrapType(java.lang.Object t)
                                          throws ReadException

Throws:

ReadException

unwrapContents

protected abstract java.lang.Object unwrapContents(java.lang.Object t)
                                            throws ReadException

Throws:

ReadException

isWrapped

protected abstract boolean isWrapped(java.lang.Object t)

getInstance

public java.lang.Object getInstance(java.lang.Class<?> clazz)
                             throws ReadException

Produces an instance of an object based on its deserialized contents and a target class. This method implements the default technique for obtaining an instance of an object: just ask for an instance based on the class, using the newInstance() method.

Parameters:

clazz - The target class for the object

Returns:

An instance of the object

Throws:

ReadException - If the operation cannot be carried on

addClassLoader

public void addClassLoader(java.lang.ClassLoader cl)

Adds a new class loader used to create new class instances

Parameters:

cl - The class loader

findClass

public java.lang.Class<?> findClass(java.lang.String class_name)
                             throws java.lang.ClassNotFoundException

Finds a class by its name

Parameters:

class_name - The name of the class

Returns:

The class

Throws:

java.lang.ClassNotFoundException - Thrown if the class could not be found

setField

public static void setField(java.lang.Object o,
                            java.lang.String field_name,
                            java.lang.Object value)
                     throws ReadException

Sets the value of a field in an object

Parameters:

o - The object

field_name - The name of the field to set

value - The value to set

Throws:

ReadException - Thrown if the value cannot be assigned to this field