jadex.commons.transformation.binaryserializer

Class AbstractCodec

java.lang.Object

jadex.commons.transformation.binaryserializer.AbstractCodec

All Implemented Interfaces:

IDecoderHandler, ITraverseProcessor

Direct Known Subclasses:

ArrayCodec, BeanCodec, ClassCodec, CollectionCodec, ColorCodec, DateCodec, EnumCodec, EnumerationCodec, ImageCodec, InetAddressCodec, LoggingLevelCodec, LogRecordCodec, MapCodec, MultiCollectionCodec, NumberCodec, RectangleCodec, StringCodec, TimestampCodec, TupleCodec, URLCodec, UUIDCodec

public abstract class AbstractCodec
extends Object
implements ITraverseProcessor, IDecoderHandler

Constructor Summary

Constructors

Constructor and Description
AbstractCodec()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReference(Object object, Class clazz, EncodingContext ec) Test if the codec allows referencing.
abstract Object	createObject(Class clazz, DecodingContext context) Creates the object during decoding.
Object	decode(Class clazz, DecodingContext context) Decodes an object.
Object	decodeSubObjects(Object object, Class clazz, DecodingContext context) Decodes and adds sub-objects during decoding.
abstract Object	encode(Object object, Class<?> clazz, List<ITraverseProcessor> processors, Traverser traverser, Map<Object,Object> traversed, boolean clone, EncodingContext ec) Encode the object.
Object	process(Object object, Class<?> clazz, List<ITraverseProcessor> processors, Traverser traverser, Map<Object,Object> traversed, boolean clone, ClassLoader targetcl, Object context) Process an object.
void	recordKnownDecodedObject(Object object, DecodingContext context) Record object as known during decoding, allows different behavior if needed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.transformation.traverser.ITraverseProcessor

isApplicable

Methods inherited from interface jadex.commons.transformation.binaryserializer.IDecoderHandler

isApplicable

Constructor Detail

AbstractCodec

public AbstractCodec()

Method Detail

process

public Object process(Object object,
             Class<?> clazz,
             List<ITraverseProcessor> processors,
             Traverser traverser,
             Map<Object,Object> traversed,
             boolean clone,
             ClassLoader targetcl,
             Object context)

Process an object.

Specified by:

process in interface ITraverseProcessor

Parameters:

object - The object.

targetcl - If not null, the traverser should make sure that the result object is compatible with the class loader, e.g. by cloning the object using the class loaded from the target class loader.

Returns:

The processed object.

canReference

public boolean canReference(Object object,
                   Class clazz,
                   EncodingContext ec)

Test if the codec allows referencing.

Parameters:

object - The object.

clazz - The class.

ec - The encoding context.

Returns:

True, if the codec allows referencing.

encode

public abstract Object encode(Object object,
            Class<?> clazz,
            List<ITraverseProcessor> processors,
            Traverser traverser,
            Map<Object,Object> traversed,
            boolean clone,
            EncodingContext ec)

Encode the object.

decode

public Object decode(Class clazz,
            DecodingContext context)

Decodes an object.

Specified by:

decode in interface IDecoderHandler

Parameters:

clazz - The class of the object.

context - The decoding context.

Returns:

The decoded object.

createObject

public abstract Object createObject(Class clazz,
                  DecodingContext context)

Creates the object during decoding.

Parameters:

clazz - The class of the object.

context - The decoding context.

Returns:

The created object.

recordKnownDecodedObject

public void recordKnownDecodedObject(Object object,
                            DecodingContext context)

Record object as known during decoding, allows different behavior if needed.

decodeSubObjects

public Object decodeSubObjects(Object object,
                      Class clazz,
                      DecodingContext context)

Decodes and adds sub-objects during decoding.

Parameters:

object - The instantiated object.

clazz - The class of the object.

context - The decoding context.

Returns:

The finished object.