net.sf.joafip.store.service.objectio.serialize

Class ObjectIODummy

java.lang.Object

net.sf.joafip.store.service.objectio.serialize.ObjectIODummy

All Implemented Interfaces:

IObjectInput, IObjectOutput

@NotStorableClass
public class ObjectIODummy
extends Object
implements IObjectInput, IObjectOutput

do nothing implementation

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
ObjectIODummy()

Method Summary

Methods

Modifier and Type	Method and Description
int	byteSize(ObjectAndPersistInfo objectAndItsClassInfo, int headerDataSize) compute bytes needs to store an object state for a class it is number of byte to store object state + bytes to store object class identifier
ObjectAndPersistInfo	createObject(DataRecordIdentifier dataRecordIdentifier, byte[] binary, ClassInfo classInfo, StorageInfo storageInfo) creation of a not existing object set data record associated to created object as soon as it is created
DataRecordIdentifier[]	getReferencedList(byte[] binary, int beginOffset) get the referenced object's data identifier from binary data containing object state
boolean	isImmediate()
boolean	isLazy()
boolean	isValueChanged(ObjectAndPersistInfo objectAndItsClassInfo) to know if object state change according to its original value also compute reference change list
void	prepareWrite(ObjectAndPersistInfo objectAndItsClassInfo) prepare possible write of object
void	setGarbageManagement(boolean garbageManagement)
void	setObjectState(ObjectAndPersistInfo objectAndPersistInfo, byte[] binary, int offset) set state of existing object by reading in the binary data object state is after the data header ( number of link and class name identifier)
void	setReferenceChangeListForNewObject(ObjectAndPersistInfo objectAndItsClassInfo) compute reference change list for new object
void	unsetObjectState(ObjectAndPersistInfo objectAndItsClassInfo)
ObjectClassInfoAndDeclared[]	willNotBeWrote(ObjectAndPersistInfo objectAndItsClassInfo)
ObjectClassInfoAndDeclared[]	writeBody(byte[] binary, int bodyBeginOffset, ObjectAndPersistInfo objectAndItsClassInfo, boolean updateOriginalValue) write body: body is data after number of link that represent object state

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectIODummy

public ObjectIODummy()

Method Detail

byteSize

public int byteSize(ObjectAndPersistInfo objectAndItsClassInfo,
           int headerDataSize)
             throws ObjectIOException,
                    ObjectIOInvalidClassException,
                    ObjectIONotSerializableException,
                    ObjectIODataRecordNotFoundException,
                    ObjectIOClassNotFoundException,
                    ObjectIODataCorruptedException

Description copied from interface: IObjectOutput

compute bytes needs to store an object state for a class
it is number of byte to store object state + bytes to store object class identifier

Specified by:

byteSize in interface IObjectOutput

Parameters:

objectAndItsClassInfo - the object

Returns:

byte size for class instance storing

Throws:

ObjectIOException - data to store size error

ObjectIOInvalidClassException

ObjectIONotSerializableException

ObjectIODataRecordNotFoundException

ObjectIOClassNotFoundException

ObjectIODataCorruptedException

createObject

public ObjectAndPersistInfo createObject(DataRecordIdentifier dataRecordIdentifier,
                                byte[] binary,
                                ClassInfo classInfo,
                                StorageInfo storageInfo)
                                  throws ObjectIOException,
                                         ObjectIODataRecordNotFoundException,
                                         ObjectIOClassNotFoundException,
                                         ObjectIOInvalidClassException,
                                         ObjectIODataCorruptedException,
                                         ObjectIONotSerializableException

Description copied from interface: IObjectInput

creation of a not existing object
set data record associated to created object as soon as it is created

Specified by:

createObject in interface IObjectInput

Parameters:

dataRecordIdentifier - the data record identifier for data record that contains object state

binary - data of data record for object

classInfo - the object class information.the class can not exist.the object class can be different than object.getClass()

Returns:

object created

Throws:

ObjectIOException - object creation error

ObjectIODataRecordNotFoundException - data record for object not found

ObjectIOClassNotFoundException

ObjectIOInvalidClassException

ObjectIODataCorruptedException

ObjectIONotSerializableException

getReferencedList

public DataRecordIdentifier[] getReferencedList(byte[] binary,
                                       int beginOffset)
                                         throws ObjectIOException

Description copied from interface: IObjectInput

get the referenced object's data identifier from binary data containing object state

Specified by:

getReferencedList in interface IObjectInput

Parameters:

binary - binary data of data record associated to object

beginOffset - start of field/element data in binary

Returns:

the referenced on object list

Throws:

ObjectIOException

isImmediate

public boolean isImmediate()

Specified by:

isImmediate in interface IObjectInput

Returns:

true if immediate loading ( not lazy )

isLazy

public boolean isLazy()

Specified by:

isLazy in interface IObjectInput

Returns:

true if lazy loading ( not immediate )

isValueChanged

public boolean isValueChanged(ObjectAndPersistInfo objectAndItsClassInfo)
                       throws ObjectIOException,
                              ObjectIODataCorruptedException,
                              ObjectIODataRecordNotFoundException,
                              ObjectIOClassNotFoundException

Description copied from interface: IObjectOutput

to know if object state change according to its original value
also compute reference change list

Specified by:

isValueChanged in interface IObjectOutput

Parameters:

objectAndItsClassInfo - the object to test

Returns:

true if object value changed according to value it have when reading

Throws:

ObjectIOException

ObjectIODataCorruptedException

ObjectIODataRecordNotFoundException

ObjectIOClassNotFoundException

prepareWrite

public void prepareWrite(ObjectAndPersistInfo objectAndItsClassInfo)
                  throws ObjectIOException,
                         ObjectIOInvalidClassException,
                         ObjectIONotSerializableException,
                         ObjectIODataRecordNotFoundException,
                         ObjectIOClassNotFoundException,
                         ObjectIODataCorruptedException

Description copied from interface: IObjectOutput

prepare possible write of object

Specified by:

prepareWrite in interface IObjectOutput

Parameters:

objectAndItsClassInfo - the object

Throws:

ObjectIOException

ObjectIOInvalidClassException

ObjectIONotSerializableException

ObjectIODataRecordNotFoundException

ObjectIOClassNotFoundException

ObjectIODataCorruptedException

setGarbageManagement

public void setGarbageManagement(boolean garbageManagement)

Specified by:

setGarbageManagement in interface IObjectOutput

setObjectState

public void setObjectState(ObjectAndPersistInfo objectAndPersistInfo,
                  byte[] binary,
                  int offset)
                    throws ObjectIOException,
                           ObjectIODataRecordNotFoundException,
                           ObjectIOInvalidClassException,
                           ObjectIOClassNotFoundException,
                           ObjectIODataCorruptedException,
                           ObjectIONotSerializableException

Description copied from interface: IObjectInput

set state of existing object by reading in the binary data
object state is after the data header ( number of link and class name identifier)

Specified by:

setObjectState in interface IObjectInput

Parameters:

objectAndPersistInfo - object to set

binary - binary data containing the object state

offset - begin of body data in record, it is header data size

Throws:

ObjectIOException - reading error

ObjectIODataRecordNotFoundException - data record not found in file

ObjectIOInvalidClassException

ObjectIOClassNotFoundException

ObjectIODataCorruptedException

ObjectIONotSerializableException

setReferenceChangeListForNewObject

public void setReferenceChangeListForNewObject(ObjectAndPersistInfo objectAndItsClassInfo)
                                        throws ObjectIOException

Description copied from interface: IObjectOutput

compute reference change list for new object

Specified by:

setReferenceChangeListForNewObject in interface IObjectOutput

Throws:

ObjectIOException

unsetObjectState

public void unsetObjectState(ObjectAndPersistInfo objectAndItsClassInfo)
                      throws ObjectIOException,
                             ObjectIOInvalidClassException

Specified by:

unsetObjectState in interface IObjectInput

Throws:

ObjectIOException

ObjectIOInvalidClassException

willNotBeWrote

public ObjectClassInfoAndDeclared[] willNotBeWrote(ObjectAndPersistInfo objectAndItsClassInfo)
                                            throws ObjectIOException

Specified by:

willNotBeWrote in interface IObjectOutput

Parameters:

objectAndItsClassInfo - the object which for state will not be wrote

Returns:

soon object referenced if was wrote

Throws:

ObjectIOException

writeBody

public ObjectClassInfoAndDeclared[] writeBody(byte[] binary,
                                     int bodyBeginOffset,
                                     ObjectAndPersistInfo objectAndItsClassInfo,
                                     boolean updateOriginalValue)
                                       throws ObjectIOException,
                                              ObjectIOInvalidClassException,
                                              ObjectIONotSerializableException,
                                              ObjectIODataCorruptedException

Description copied from interface: IObjectOutput

write body: body is data after number of link that represent object state

Specified by:

writeBody in interface IObjectOutput

Parameters:

binary - binary data of data record associated to object

bodyBeginOffset - offset in binary data of begin of body, it is the header data size

objectAndItsClassInfo - the object which for state is to write

updateOriginalValue - true if set original value to current value ( true only when serialization is done to update heap file )

Returns:

son object referenced in wrote data record

Throws:

ObjectIOException

ObjectIOInvalidClassException

ObjectIONotSerializableException

ObjectIODataCorruptedException