IObjectOutput (JOAFIP "Abstract" Parent Project 4.0.0b9)

All Known Implementing Classes:

AbstractObjectOutput, AbstractObjectOutputGeneric, AbstractObjectOutputGenericNotStatic, AbstractObjectOutputSerialize, ObjectIODummy, ObjectOutputExternalizable, ObjectOutputForArray, ObjectOutputForBasic, ObjectOutputForEnum, ObjectOutputForString, ObjectOutputGeneric, ObjectOutputSerializable, ObjectOutputSerialize, ObjectOutputSerializeGZipped, ObjectOutputSerializeZipped
```
public interface IObjectOutput
```
object output interface
class implementing this provide output service for a type and/or storage mode

Author:

luc peuvrier

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
`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`	`setReferenceChangeListForNewObject(ObjectAndPersistInfo objectAndItsClassInfo)` compute reference change list for new object
`ObjectClassInfoAndDeclared[]`	`willNotBeWrote(ObjectAndPersistInfo objectAndPersistInfo)`
`ObjectClassInfoAndDeclared[]`	`writeBody(byte[] binary, int bodyBeginOffset, ObjectAndPersistInfo objectAndItsClassInfo, boolean updateOriginalValue)` write body: body is data after number of link that represent object state

Method Detail

setGarbageManagement

void setGarbageManagement(boolean garbageManagement)

prepareWrite

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

prepare possible write of object

Parameters:: objectAndItsClassInfo - the object
Throws:: ObjectIOException; ObjectIONotSerializableException; ObjectIOInvalidClassException; ObjectIODataCorruptedException; ObjectIOClassNotFoundException; ObjectIODataRecordNotFoundException; ObjectIOTooBigForSerializationException

byteSize

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

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

Parameters:: objectAndItsClassInfo - the object; headerDataSize -
Returns:: byte size for class instance storing
Throws:: ObjectIOException - data to store size error; ObjectIONotSerializableException; ObjectIOInvalidClassException; ObjectIODataCorruptedException; ObjectIOClassNotFoundException; ObjectIODataRecordNotFoundException

isValueChanged

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

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

Parameters:: objectAndItsClassInfo - the object to test
Returns:: true if object value changed according to value it have when reading
Throws:: ObjectIOException; ObjectIODataRecordNotFoundException; ObjectIODataCorruptedException; ObjectIOClassNotFoundException

writeBody

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

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

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; ObjectIONotSerializableException; ObjectIOInvalidClassException; ObjectIODataCorruptedException

willNotBeWrote

ObjectClassInfoAndDeclared[] willNotBeWrote(ObjectAndPersistInfo objectAndPersistInfo)
                                            throws ObjectIOException

Parameters:: objectAndPersistInfo - the object which for state will not be wrote
Returns:: soon object referenced if was wrote
Throws:: ObjectIOException

setReferenceChangeListForNewObject

void setReferenceChangeListForNewObject(ObjectAndPersistInfo objectAndItsClassInfo)
                                        throws ObjectIOException

compute reference change list for new object

Parameters:: objectAndItsClassInfo -
Throws:: ObjectIOException

Interface IObjectOutput