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

Interface IObjectInput

All Known Implementing Classes:

AbstractImmediateObjectInput, AbstractObjectInput, AbstractObjectInputGeneric, AbstractObjectInputGenericNotStatic, AbstractObjectInputImmediate, AbstractObjectInputLazy, ObjectInputForArray, ObjectInputForBasic, ObjectInputForEnum, ObjectInputForString, ObjectInputImmediateExternalizable, ObjectInputImmediateGeneric, ObjectInputImmediateSerializable, ObjectInputLazyExternalizable, ObjectInputLazyGeneric, ObjectInputLazySerializable, ObjectInputSerialize, ObjectInputSerializeGZipped, ObjectInputSerializeZipped, ObjectIODummy

public interface IObjectInput

object input interface
class implementing this provide input service for a type and/or storage mode

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
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()
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	unsetObjectState(ObjectAndPersistInfo objectAndItsClassInfo)

Method Detail

isLazy

boolean isLazy()

Returns:

true if lazy loading ( not immediate )

isImmediate

boolean isImmediate()

Returns:

true if immediate loading ( not lazy )

createObject

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

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

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()

storageInfo -

Returns:

object created

Throws:

ObjectIODataRecordNotFoundException - data record for object not found

ObjectIOException - object creation error

ObjectIODataCorruptedException

ObjectIOInvalidClassException

ObjectIOClassNotFoundException

ObjectIONotSerializableException

setObjectState

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

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)

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:

ObjectIODataRecordNotFoundException - data record not found in file

ObjectIOException - reading error

ObjectIOInvalidClassException

ObjectIODataCorruptedException

ObjectIOClassNotFoundException

ObjectIONotSerializableException

unsetObjectState

void unsetObjectState(ObjectAndPersistInfo objectAndItsClassInfo)
                      throws ObjectIOException,
                             ObjectIOInvalidClassException

Parameters:

objectAndItsClassInfo -

Throws:

ObjectIOException

ObjectIOInvalidClassException

getReferencedList

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

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

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