ca.uqac.lif.azrael

Class ObjectPrinter<T>

java.lang.Object

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

Type Parameters:

T - The format used to print the object's contents

Direct Known Subclasses:

ClonePrinter, JsonPrinter, SizePrinter, XmlPrinter

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

Prints the content of an object to a given format.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<PrintHandler<T>>	m_handlers A list of objects that handle the printing of objects of various types
protected PrintHandler<T>	m_reflectionHandler The default handler to use when no other handler accepts an object
protected boolean	m_usePrintable Whether to use the Readable interface when an object implements it

Constructor Summary

Constructors

Constructor and Description
ObjectPrinter() Creates a new object printer

Method Summary

Modifier and Type	Method and Description
T	print(java.lang.Object o) Serializes the contents of an object.
void	reset() Resets the state of the printer
boolean	usesPrintable() Tells whether the object printer uses the Printable interface when an object implements it
abstract T	wrap(java.lang.Object o, T t) Wraps an object into a structure that contains its type declaration and its printed contents

Methods inherited from class java.lang.Object

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

Field Detail

m_handlers

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

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

m_reflectionHandler

protected PrintHandler<T> m_reflectionHandler

The default handler to use when no other handler accepts an object

m_usePrintable

protected boolean m_usePrintable

Whether to use the Readable interface when an object implements it

Constructor Detail

ObjectPrinter

public ObjectPrinter()

Creates a new object printer

Method Detail

print

public T print(java.lang.Object o)
        throws PrintException

Serializes the contents of an object. If the object implements the Printable interface, it is serialized by calling its print() method. Otherwise, the serializer uses reflection to extract the object's fields and create a key-value map of field names associated to their serialized contents. In such a case, fields that are declared as transient in the object are ignored.

Parameters:

o - The object

Returns:

The serialized contents

Throws:

PrintException - Thrown if an error occurs during the serialization

wrap

public abstract T wrap(java.lang.Object o,
                       T t)
                throws PrintException

Wraps an object into a structure that contains its type declaration and its printed contents

Parameters:

o - The object

t - The object's printed contents

Returns:

The printed structure

Throws:

PrintException - Thrown if the print operation caused an error

reset

public void reset()

Resets the state of the printer

usesPrintable

public boolean usesPrintable()

Tells whether the object printer uses the Printable interface when an object implements it

Returns:

true or false