IFilePersistence (JOAFIP "Abstract" Parent Project 4.0.0b9)

All Known Implementing Classes:

AbstractFilePersistenceDelegatingToStore, FilePersistence
```
public interface IFilePersistence
```
Author:

luc peuvrier

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProhibitedPackage(String packageName)` Add a prohibited package.
`void`	`addToNotCheckMethod(Class<?> clazz)`
`void`	`addToNotCheckMethod(Constructor<?> constructor)`
`void`	`addToNotCheckMethod(Method method)`
`void`	`addToNotCheckMethod(String objectClassName, String absoluteMethodName)`
`Collection<ClassInfo>`	`allClassInformation()`
`void`	`autoSaveSetup(int maxInMemoryThreshold)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`ClassInfo`	`classInfoOfObject(Object object)`
`Class<?>`	`classOfObject(Object object)`
`void`	`clear()` clear all persisted data
`void`	`close()` close ( important to close files ) do not save modification
`Object`	`copy(Object sourceObject)` Deprecated.
`IAloneDataAccessSession`	`createAloneDataAccessSession()` Deprecated.
`IDataAccessSession`	`createDataAccessSession()`
`IExclusiveDataAccessSession`	`createExclusiveDataAccessSession()`
`Object`	`deepCopy(Object sourceObject, boolean forceLoad)` deep copy of object, useful to detach from persistence ( proxy object to non-proxy, detached state if use java agent )
`void`	`disableBackgroundGarbageSweep()` disable background garbage sweep operation (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`enableBackgroundGarbageSweep(int sleepTime)` enable background garbage sweep operation (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`long`	`freeSize()` get number of free bytes in data file
`int`	`garbageSweep(String filePath)` garbage sweep, remove data record for object not attached to root should be call only when session closed
`int`	`getClassIdentifier(Class<?> clazz)`
`ClassLoader`	`getClassLoader()`
`int`	`getNumberOfDataRecord()` get number of data record in heap file
`int`	`getNumberOfFreeRecord()` get number of free record in heap file
`int`	`getNumberOfGarbageCandidate()` get the number of known garbage candidate
`int`	`getNumberOfModified()`
`int`	`getNumberOfObjectExported()`
`int`	`getNumberOfObjectState()`
`int`	`getNumberOfReferenced()`
`int`	`getNumberOfToGarbage()` get the number of record to garbage
`int`	`getNumberOfVisited()`
`int`	`getNumberOfWeakReference()`
`URL`	`getResource(String resourceName)`
`String`	`getStorageFileName()`
`Set<String>`	`getVisitedObjectSet()` see `setRecordSaveActions(boolean)`
`List<String>`	`getWroteArrays()` see `setRecordSaveActions(boolean)`
`Map<String,MutableInteger>`	`getWroteObjectSet()` see `setRecordSaveActions(boolean)`
`boolean`	`isAutoSaveEnabled()`
`boolean`	`isClosed()`
`boolean`	`isGarbageManagement()`
`boolean`	`isOpened()`
`boolean`	`isProxy(Object object)` to know if object is a proxy
`void`	`keptInMemory(String key, Object object)` Inform that an object is kept in memory, never persisted since a persisted object can reference a kept in memory object a key is use to make able to recreate link between read from storage object and kept in memory object All instance of the object class can not be persisted (PROPS) can not be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`String`	`keyOfObjectKeptInMemory(Object object)`
`ClassInfo`	`knownAsNotExisting(String className)` declare a class known as not existing
`void`	`maintainInMemorySetup(int maintainedInMemoryQuota)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`Object`	`newProxyInstance(Class<?> objectClass)`
`Object`	`newProxyInstance(Class<?> objectClass, Class<?>[] parameterTypes, Object[] initargs)` create object as proxy instance, deep copy of all member see `FilePersistence.targetCause(Exception)`
`Object`	`newProxyInstance(Object object)` deep copy where all copy object are proxied if not enhanced by java agent see `FilePersistence.targetCause(Exception)`
`void`	`referencedByPesistedStaticField(Class<?> classHavingStaticFieldReferenced)` instance referenced by static field of class are kept in memory
`void`	`referencedByPesistedStaticField(Class<?>[] classHavingStaticFieldReferenced)` instance referenced by static field of classes are kept in memory
`void`	`removeWriteSubstitution(Class<?> replaced)`
`void`	`removeWriteSubstitution(String replacedName)`
`void`	`setAutoSaveEnabled(boolean enabled)` set auto save enabled (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setAutoSaveEventListener(IAutoSaveEventListener saveEventListener)` set save event listener
`void`	`setChangeLogEnabled(boolean enabled, int maxNumberOfChangeLog)` set enable state of file change logging (PROPS) can not be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setClassLoader(ClassLoader classLoader)` set the class loader use by proxy creation to define class the class loader use by proxy creation to define class should be the same used to load class of object to be persisted
`void`	`setDeprecatedInStore(Class<?> objectClass)` mark class to be deprecated in store, may exist in store but will not be write more if class not accessible use `setDeprecatedInStore(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setDeprecatedInStore(Class<?>[] objectClasses)` mark class to be deprecated in store, may exist in store but will not be write more `setDeprecatedInStore(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setDeprecatedInStore(String objectClassName)` mark class to be deprecated in store, may exist in store but will not be write more (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setDeprecatedInStore(String[] objectClassNames)` mark class to be deprecated in store, may exist in store but will not be write more (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setExportListener(IExporterListener listener)`
`void`	`setForceEnhance(Class<?> objectClass)` force class to be enhanced even if have public method if class not accessible see `setForceEnhance(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setForceEnhance(Class<?>[] objectClasses)` force classes to be enhanced even if have public method if class not accessible see `setForceEnhance(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setForceEnhance(String objectClassName)` force class to be enhanced even if have public method (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setForceEnhance(String[] objectClassNames)` force classes to be enhanced even if have public method (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setGarbageListener(IGarbageListener listener)` set garbage listener (PROPS) can not be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setImportListener(IImportListener listener)`
`void`	`setMaintainedInMemoryEnabled(boolean enabled)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNoLazyLoad(Class<?> objectClass)` set no use of lazy load for a class if class not accessible see `setNoLazyLoad(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNoLazyLoad(Class<?>[] objectClasses)` set no use of lazy load for the classes if class not accessible see `setNoLazyLoad(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNoLazyLoad(String objectClassName)` set no use of lazy load for a class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNoLazyLoad(String[] objectClassNames)` set no use of lazy load for the classes (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNotPersistedField(Class<?> clazz, String[] fieldNames)`
`void`	`setNotPersistedField(String objectClassName, String[] fieldNames)`
`void`	`setNotStorable(Class<?> objectClass)` mark class to be not storable if class not accessible use `setNotStorable(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNotStorable(Class<?>[] objectClasses)` mark classes to be not storable if class not accessible use `setNotStorable(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNotStorable(String objectClassName)` mark class to be not storable (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setNotStorable(String[] objectClassNames)` mark classes to be not storable (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setObjectIOForClass(Class<?> objectClass, Class<? extends IObjectInput> objectInputClass, Class<? extends IObjectOutput> objectOutputClass)` set object input output manager for a class if class not accessible see `#setObjectIOForClass(String, Class)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setObjectIOForClass(String objectClassName, Class<? extends IObjectInput> objectInputClass, Class<? extends IObjectOutput> objectOutputClass)` set object input output manager for a class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setRecordSaveActions(boolean recordActions)` activation of object write recording when saving see `getWroteObjectSet()` and `getVisitedObjectSet()` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setRecordSaveActions(boolean recordActions, ISaveRecordActionListener saveRecordActionListener)`
`void`	`setSaveRecordActionListener(ISaveRecordActionListener saveRecordActionListener)`
`void`	`setStorable(Class<?> objectClass)` mark class to be storable if class not accessible use `setStorable(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStorable(Class<?>[] objectClasses)` mark classes to be storable if class not accessible use `setStorable(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStorable(String objectClassName)` mark class to be storable (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStorable(String[] objectClassNames)` mark classes to be storable (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreNotUseStandardSerialization(Class<?> objectClass)` set not use standard serialization for a serializable class if class not accessible see `setStoreNotUseStandardSerialization(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreNotUseStandardSerialization(Class<?>[] objectClasses)` set not use standard serialization for a serializable classes if class not accessible see `setStoreNotUseStandardSerialization(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreNotUseStandardSerialization(String objectClassName)` set not use standard serialization for a serializable class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreNotUseStandardSerialization(String[] objectClassNames)` set not use standard serialization for a serializable classes (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreOnlyMarkedStorable(boolean storeOnlyMarkedStorable)` to specify if only class marked by `StorableClass` can be persisted or not
`void`	`setStoreSerializeAndGZippedInOneRecord(Class<?> objectClass)` set storage mode serialized and GZipped for a serializable class if class not accessible see `setStoreSerializeAndGZippedInOneRecord(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndGZippedInOneRecord(Class<?>[] objectClasses)` set storage mode serialized and GZipped for a serializable classes if class not accessible see `setStoreSerializeAndGZippedInOneRecord(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndGZippedInOneRecord(String objectClassName)` set storage mode serialized and GZipped for a serializable class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndGZippedInOneRecord(String[] objectClassNames)` set storage mode serialized and GZipped for a serializable classes (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndZippedInOneRecord(Class<?> objectClass)` set storage mode serialized and Zipped for a serializable class if class is not accessible see `setStoreSerializeAndZippedInOneRecord(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndZippedInOneRecord(Class<?>[] objectClasses)` set storage mode serialized and Zipped for a serializable classes if class is not accessible see `setStoreSerializeAndZippedInOneRecord(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndZippedInOneRecord(String objectClassName)` set storage mode serialized and Zipped for a serializable class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeAndZippedInOneRecord(String[] objectClassNames)` set storage mode serialized and Zipped for a serializable classes (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeInOneRecord(Class<?> objectClass)` set storage mode serialized for a serializable class if class is not accessible see `setStoreSerializeInOneRecord(String)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeInOneRecord(Class<?>[] objectClasses)` set storage mode serialized for a serializable classes if class is not accessible see `setStoreSerializeInOneRecord(String[])` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeInOneRecord(String objectClassName)` set storage mode serialized for a serializable class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setStoreSerializeInOneRecord(String[] objectClassNames)` set storage mode serialized for a serializable classes (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setSubstituteObjectManager(Class<?> objectClass, Class<?> substituteObjectClass, ISubstituteObjectManager substituteObjectManager)` set substitution for object of a class writing and reading if class is not accessible see `setSubstituteObjectManager(String, Class, ISubstituteObjectManager)`
`void`	`setSubstituteObjectManager(String objectClassName, Class<?> substituteObjectClass, ISubstituteObjectManager substituteObjectManager)` set substitution for object of a class writing and reading
`void`	`setSubstitutionOfJavaUtilCollection(boolean enabled)` activate java util collection substitution PVector for Vector PLinkedList for LinkedList PArrayList for ArrayList PHashSet for HashSet PLinkedHashSet for LinkedHashSet PTreeSet for TreeSet PHashMap for HashMap PLinkedHashMap for LinkedHashMap PTreeMap for TreeMap PHashMap for HashTable (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setWriteSubstitution(Class<?> replaced, Class<?> substitute, ISubsituteSynchronizer synchronizer)` record a class substitution at write if class is not accessible see `setWriteSubstitution(String, Class, ISubsituteSynchronizer)` (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setWriteSubstitution(String replacedName, Class<?> substitute, ISubsituteSynchronizer synchronizer)` record a class substitution at write (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`setZipCompressionLevel(int zipCompressionLevel)` set the compression level for class annotated `StoreSerializeAndZippedInOneRecord` or defined using `setStoreSerializeAndZippedInOneRecord(Class)` or `setStoreSerializeAndZippedInOneRecord(Class[])` the compression level have value 0 thru 9: `#NO_COMPRESSION` `#BEST_SPEED` ....
`void`	`storedEnum(Class<? extends Enum<?>> enumClass)` Deprecated.
`void`	`storedEnum(Class<? extends Enum<?>>[] enumClasses)` Deprecated.
`void`	`storedEnum(Enum<?> enumObject)` Deprecated.
`void`	`storedImmutableEnum(Class<? extends Enum<?>> enumClass)` declare persisted immutable enum by its class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`storedImmutableEnum(Class<? extends Enum<?>>[] enumClasses)` declare persisted immutable enum by their class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`storedMutableEnum(Class<? extends Enum<?>> enumClass)` declare persisted mutable enum by its class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`void`	`storedMutableEnum(Class<? extends Enum<?>>[] enumClasses)` declare persisted mutable enum by their class (PROPS) can be set using properties file see `FilePersistence.FilePersistence(String, boolean)`
`long`	`totalSize()` get total size of data file
`void`	`usedForClassNameManagement(Set<DataRecordIdentifier> setToUpdate)`
`long`	`usedSize()` get number of bytes used to store data in data file
`void`	`xmlExport(String directoryName, String temporaryDirectoryName, boolean exportPersistedClassByteCode)` export persisted data in file export.xml put in `directoryName directory can also export byte code of class of persisted object`
`void`	`xmlImport(String directoryName, boolean validating)` import from exported data in `directoryName directory`

- Method Detail
  - setChangeLogEnabled
```
void setChangeLogEnabled(boolean enabled,
                       int maxNumberOfChangeLog)
                         throws FilePersistenceException
```
    set enable state of file change logging
    (PROPS) can not be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enabled - true if change log enabled
    maxNumberOfChangeLog - max number of state change log
    
    Throws:
    
    FilePersistenceException
  - setZipCompressionLevel
```
void setZipCompressionLevel(int zipCompressionLevel)
                            throws FilePersistenceException
```
    set the compression level for class annotated StoreSerializeAndZippedInOneRecord or defined using setStoreSerializeAndZippedInOneRecord(Class) or setStoreSerializeAndZippedInOneRecord(Class[])
    the compression level have value 0 thru 9:
    - #NO_COMPRESSION
    - #BEST_SPEED
    - ....
    - #BEST_COMPRESSION
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    Parameters:
    zipCompressionLevel - the zip the compression level (0-9) for object storing using zipped serialization
    
    Throws:
    
    FilePersistenceException
  - setGarbageListener
```
void setGarbageListener(IGarbageListener listener)
                        throws FilePersistenceException
```
    set garbage listener
    (PROPS) can not be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    listener - the garbage listener, can be null to remove previous one
    
    Throws:
    
    FilePersistenceException
  - setSubstitutionOfJavaUtilCollection
```
void setSubstitutionOfJavaUtilCollection(boolean enabled)
                                         throws FilePersistenceException
```
    activate java util collection substitution
    - PVector for Vector
    - PLinkedList for LinkedList
    - PArrayList for ArrayList
    - PHashSet for HashSet
    - PLinkedHashSet for LinkedHashSet
    - PTreeSet for TreeSet
    - PHashMap for HashMap
    - PLinkedHashMap for LinkedHashMap
    - PTreeMap for TreeMap
    - PHashMap for HashTable
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    Parameters:
    enabled -
    
    Throws:
    
    FilePersistenceException
  - setWriteSubstitution
```
void setWriteSubstitution(Class<?> replaced,
                        Class<?> substitute,
                        ISubsituteSynchronizer synchronizer)
                          throws FilePersistenceException
```
    record a class substitution at write
    if class is not accessible see setWriteSubstitution(String, Class, ISubsituteSynchronizer)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    replaced - the replaced class
    substitute - the substitute for the replaced class
    synchronizer - the state synchronizer for class and its substitute
    
    Throws:
    
    FilePersistenceException
  - removeWriteSubstitution
```
void removeWriteSubstitution(Class<?> replaced)
                             throws FilePersistenceException
```
    Throws:
    
    FilePersistenceException
  - setWriteSubstitution
```
void setWriteSubstitution(String replacedName,
                        Class<?> substitute,
                        ISubsituteSynchronizer synchronizer)
                          throws FilePersistenceException
```
    record a class substitution at write
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    replacedName - the replaced class by its name
    substitute - the substitute for the replaced class
    synchronizer - the state synchronizer for class and its substitute
    
    Throws:
    
    FilePersistenceException
  - removeWriteSubstitution
```
void removeWriteSubstitution(String replacedName)
                             throws FilePersistenceException,
                                    FilePersistenceClassNotFoundException
```
    Throws:
    
    FilePersistenceException
    
    FilePersistenceClassNotFoundException
  - setNoLazyLoad
```
void setNoLazyLoad(Class<?> objectClass)
                   throws FilePersistenceException
```
    set no use of lazy load for a class
    if class not accessible see setNoLazyLoad(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setNoLazyLoad
```
void setNoLazyLoad(Class<?>[] objectClasses)
                   throws FilePersistenceException
```
    set no use of lazy load for the classes
    if class not accessible see setNoLazyLoad(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setNoLazyLoad
```
void setNoLazyLoad(String objectClassName)
```
    set no use of lazy load for a class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
  - setNoLazyLoad
```
void setNoLazyLoad(String[] objectClassNames)
```
    set no use of lazy load for the classes
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
  - setStoreNotUseStandardSerialization
```
void setStoreNotUseStandardSerialization(Class<?> objectClass)
                                         throws FilePersistenceException
```
    set not use standard serialization for a serializable class
    if class not accessible see setStoreNotUseStandardSerialization(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setStoreNotUseStandardSerialization
```
void setStoreNotUseStandardSerialization(Class<?>[] objectClasses)
                                         throws FilePersistenceException
```
    set not use standard serialization for a serializable classes if class not accessible see setStoreNotUseStandardSerialization(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setStoreNotUseStandardSerialization
```
void setStoreNotUseStandardSerialization(String objectClassName)
                                         throws FilePersistenceException
```
    set not use standard serialization for a serializable class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setStoreNotUseStandardSerialization
```
void setStoreNotUseStandardSerialization(String[] objectClassNames)
                                         throws FilePersistenceException
```
    set not use standard serialization for a serializable classes
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndGZippedInOneRecord
```
void setStoreSerializeAndGZippedInOneRecord(Class<?> objectClass)
                                            throws FilePersistenceException
```
    set storage mode serialized and GZipped for a serializable class
    if class not accessible see setStoreSerializeAndGZippedInOneRecord(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndGZippedInOneRecord
```
void setStoreSerializeAndGZippedInOneRecord(Class<?>[] objectClasses)
                                            throws FilePersistenceException
```
    set storage mode serialized and GZipped for a serializable classes if class not accessible see setStoreSerializeAndGZippedInOneRecord(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndGZippedInOneRecord
```
void setStoreSerializeAndGZippedInOneRecord(String objectClassName)
                                            throws FilePersistenceException
```
    set storage mode serialized and GZipped for a serializable class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndGZippedInOneRecord
```
void setStoreSerializeAndGZippedInOneRecord(String[] objectClassNames)
                                            throws FilePersistenceException
```
    set storage mode serialized and GZipped for a serializable classes
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndZippedInOneRecord
```
void setStoreSerializeAndZippedInOneRecord(Class<?> objectClass)
                                           throws FilePersistenceException
```
    set storage mode serialized and Zipped for a serializable class
    if class is not accessible see setStoreSerializeAndZippedInOneRecord(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndZippedInOneRecord
```
void setStoreSerializeAndZippedInOneRecord(Class<?>[] objectClasses)
                                           throws FilePersistenceException
```
    set storage mode serialized and Zipped for a serializable classes if class is not accessible see setStoreSerializeAndZippedInOneRecord(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndZippedInOneRecord
```
void setStoreSerializeAndZippedInOneRecord(String objectClassName)
                                           throws FilePersistenceException
```
    set storage mode serialized and Zipped for a serializable class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeAndZippedInOneRecord
```
void setStoreSerializeAndZippedInOneRecord(String[] objectClassNames)
                                           throws FilePersistenceException
```
    set storage mode serialized and Zipped for a serializable classes
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeInOneRecord
```
void setStoreSerializeInOneRecord(Class<?> objectClass)
                                  throws FilePersistenceException
```
    set storage mode serialized for a serializable class
    if class is not accessible see setStoreSerializeInOneRecord(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeInOneRecord
```
void setStoreSerializeInOneRecord(Class<?>[] objectClasses)
                                  throws FilePersistenceException
```
    set storage mode serialized for a serializable classes
    if class is not accessible see setStoreSerializeInOneRecord(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeInOneRecord
```
void setStoreSerializeInOneRecord(String objectClassName)
                                  throws FilePersistenceException
```
    set storage mode serialized for a serializable class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setStoreSerializeInOneRecord
```
void setStoreSerializeInOneRecord(String[] objectClassNames)
                                  throws FilePersistenceException
```
    set storage mode serialized for a serializable classes
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setStorable
```
void setStorable(Class<?> objectClass)
                 throws FilePersistenceException
```
    mark class to be storable
    if class not accessible use setStorable(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setStorable
```
void setStorable(Class<?>[] objectClasses)
                 throws FilePersistenceException
```
    mark classes to be storable if class not accessible use setStorable(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setStorable
```
void setStorable(String objectClassName)
                 throws FilePersistenceException
```
    mark class to be storable
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setStorable
```
void setStorable(String[] objectClassNames)
                 throws FilePersistenceException
```
    mark classes to be storable
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setNotStorable
```
void setNotStorable(Class<?> objectClass)
                    throws FilePersistenceException
```
    mark class to be not storable
    if class not accessible use setNotStorable(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setNotStorable
```
void setNotStorable(Class<?>[] objectClasses)
                    throws FilePersistenceException
```
    mark classes to be not storable if class not accessible use setNotStorable(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setNotStorable
```
void setNotStorable(String objectClassName)
                    throws FilePersistenceException
```
    mark class to be not storable
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setNotStorable
```
void setNotStorable(String[] objectClassNames)
                    throws FilePersistenceException
```
    mark classes to be not storable
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setDeprecatedInStore
```
void setDeprecatedInStore(Class<?> objectClass)
                          throws FilePersistenceException
```
    mark class to be deprecated in store, may exist in store but will not be write more
    if class not accessible use setDeprecatedInStore(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setDeprecatedInStore
```
void setDeprecatedInStore(Class<?>[] objectClasses)
                          throws FilePersistenceException
```
    mark class to be deprecated in store, may exist in store but will not be write more
    setDeprecatedInStore(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setDeprecatedInStore
```
void setDeprecatedInStore(String objectClassName)
                          throws FilePersistenceException
```
    mark class to be deprecated in store, may exist in store but will not be write more
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
    
    Throws:
    
    FilePersistenceException
  - setDeprecatedInStore
```
void setDeprecatedInStore(String[] objectClassNames)
                          throws FilePersistenceException
```
    mark class to be deprecated in store, may exist in store but will not be write more
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
    
    Throws:
    
    FilePersistenceException
  - setForceEnhance
```
void setForceEnhance(Class<?> objectClass)
                     throws FilePersistenceException
```
    force class to be enhanced even if have public method if class not accessible see setForceEnhance(String)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass -
    
    Throws:
    
    FilePersistenceException
  - setForceEnhance
```
void setForceEnhance(Class<?>[] objectClasses)
                     throws FilePersistenceException
```
    force classes to be enhanced even if have public method if class not accessible see setForceEnhance(String[])
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClasses -
    
    Throws:
    
    FilePersistenceException
  - setForceEnhance
```
void setForceEnhance(String objectClassName)
```
    force class to be enhanced even if have public method
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName -
  - setForceEnhance
```
void setForceEnhance(String[] objectClassNames)
```
    force classes to be enhanced even if have public method
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassNames -
  - addProhibitedPackage
```
void addProhibitedPackage(String packageName)
```
    Add a prohibited package. Ensure proxy class are not created in this package. When the package of a proxy class is not the same package than proxied class then method having only package visibility are not overrode for method call interception
    
    Parameters:
    packageName -
  - addToNotCheckMethod
```
void addToNotCheckMethod(Class<?> clazz)
```
  - addToNotCheckMethod
```
void addToNotCheckMethod(Method method)
```
  - addToNotCheckMethod
```
void addToNotCheckMethod(Constructor<?> constructor)
```
  - addToNotCheckMethod
```
void addToNotCheckMethod(String objectClassName,
                       String absoluteMethodName)
```
  - setObjectIOForClass
```
void setObjectIOForClass(Class<?> objectClass,
                       Class<? extends IObjectInput> objectInputClass,
                       Class<? extends IObjectOutput> objectOutputClass)
                         throws FilePersistenceException
```
    set object input output manager for a class
    if class not accessible see #setObjectIOForClass(String, Class)
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClass - the class for which is provide the object input output
    objectInputClass - object input manager class for the class
    objectOutputClass - object output manager class for the class
    
    Throws:
    
    FilePersistenceException - object I/O construction failure
  - setObjectIOForClass
```
void setObjectIOForClass(String objectClassName,
                       Class<? extends IObjectInput> objectInputClass,
                       Class<? extends IObjectOutput> objectOutputClass)
                         throws FilePersistenceException
```
    set object input output manager for a class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    objectClassName - the class by its name for which is provide the object input output
    objectInputClass - object input manager class for the class
    objectOutputClass - object output manager class for the class
    
    Throws:
    
    FilePersistenceException - object I/O construction failure
  - storedMutableEnum
```
void storedMutableEnum(Class<? extends Enum<?>>[] enumClasses)
                       throws FilePersistenceException
```
    declare persisted mutable enum by their class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClasses -
    
    Throws:
    
    FilePersistenceException
  - setImportListener
```
void setImportListener(IImportListener listener)
```
  - storedMutableEnum
```
void storedMutableEnum(Class<? extends Enum<?>> enumClass)
                       throws FilePersistenceException
```
    declare persisted mutable enum by its class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClass - the enum class
    
    Throws:
    
    FilePersistenceException
  - storedImmutableEnum
```
void storedImmutableEnum(Class<? extends Enum<?>>[] enumClasses)
                         throws FilePersistenceException
```
    declare persisted immutable enum by their class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClasses -
    
    Throws:
    
    FilePersistenceException
  - storedImmutableEnum
```
void storedImmutableEnum(Class<? extends Enum<?>> enumClass)
                         throws FilePersistenceException
```
    declare persisted immutable enum by its class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClass - the enum class
    
    Throws:
    
    FilePersistenceException
  - storedEnum
```
@Deprecated
void storedEnum(Class<? extends Enum<?>>[] enumClasses)
                throws FilePersistenceException
```
    Deprecated.
    
    deprecated, see storedMutableEnum(Class[])
    declare persisted enum by their class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClasses - the enum classes
    
    Throws:
    
    FilePersistenceException
  - storedEnum
```
@Deprecated
void storedEnum(Class<? extends Enum<?>> enumClass)
                throws FilePersistenceException
```
    Deprecated.
    
    declare persisted enum by its class
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClass - the enum class
    
    Throws:
    
    FilePersistenceException
  - storedEnum
```
@Deprecated
void storedEnum(Enum<?> enumObject)
                throws FilePersistenceException
```
    Deprecated.
    
    inform that enum object is persisted
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    enumClass - the enum class
    
    Throws:
    
    FilePersistenceException
  - isGarbageManagement
```
boolean isGarbageManagement()
                            throws FilePersistenceException
```
    Returns:
    true if manage garbage
    
    Throws:
    
    FilePersistenceException
  - garbageSweep
```
int garbageSweep(String filePath)
                 throws FilePersistenceException,
                        FilePersistenceClassNotFoundException,
                        FilePersistenceDataCorruptedException
```
    garbage sweep, remove data record for object not attached to root
    should be call only when session closed
    
    Parameters:
    filePath - temporary file for data record identifier set
    
    Returns:
    number of garbage data record seeped
    
    Throws:
    
    FilePersistenceException
    
    FilePersistenceClassNotFoundException
    
    FilePersistenceDataCorruptedException
  - enableBackgroundGarbageSweep
```
void enableBackgroundGarbageSweep(int sleepTime)
                                  throws FilePersistenceException
```
    enable background garbage sweep operation
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Parameters:
    sleepTime - sleep time between garbage sweep operation
    
    Throws:
    
    FilePersistenceException
  - disableBackgroundGarbageSweep
```
void disableBackgroundGarbageSweep()
                                   throws FilePersistenceException
```
    disable background garbage sweep operation
    (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean)
    
    Throws:
    
    FilePersistenceException
  - getNumberOfGarbageCandidate
```
int getNumberOfGarbageCandidate()
                                throws FilePersistenceException
```
    get the number of known garbage candidate
    
    Returns:
    the number of garbage candidate
    
    Throws:
    
    FilePersistenceException
  - getNumberOfToGarbage
```
int getNumberOfToGarbage()
                         throws FilePersistenceException
```
    get the number of record to garbage
    
    Returns:
    the number of to garbage record
    
    Throws:
    
    FilePersistenceException
  - getNumberOfDataRecord
```
int getNumberOfDataRecord()
                          throws FilePersistenceException
```
    get number of data record in heap file
    
    Returns:
    number of data record in heap file
    
    Throws:
    
    FilePersistenceException
  - getNumberOfFreeRecord
```
int getNumberOfFreeRecord()
                          throws FilePersistenceException
```
    get number of free record in heap file
    
    Returns:
    number of free record in heap file
    
    Throws:
    
    FilePersistenceException
  - usedSize
```
long usedSize()
              throws FilePersistenceException
```
    get number of bytes used to store data in data file
    
    Returns:
    number of bytes used to store data in data file
    
    Throws:
    
    FilePersistenceException
  - freeSize
```
long freeSize()
              throws FilePersistenceException
```
    get number of free bytes in data file
    
    Returns:
    number of free bytes in data file
    
    Throws:
    
    FilePersistenceException
  - totalSize
```
long totalSize()
               throws FilePersistenceException
```
    get total size of data file
    
    Returns:
    total size of data file
    
    Throws:
    
    FilePersistenceException
  - getNumberOfObjectState
```
int getNumberOfObjectState()
                           throws FilePersistenceException
```
    Returns:
    number of object with knew persistent state
    
    Throws:
    
    FilePersistenceException
  - getNumberOfWeakReference
```
int getNumberOfWeakReference()
                             throws FilePersistenceException
```
    Returns:
    number of weak reference on object with knew persistent state
    
    Throws:
    
    FilePersistenceException
  - getNumberOfReferenced
```
int getNumberOfReferenced()
                          throws FilePersistenceException
```
    Returns:
    number of hard reference on object with knew persistent state
    
    Throws:
    
    FilePersistenceException
  - getNumberOfModified
```
int getNumberOfModified()
                        throws FilePersistenceException
```
    Returns:
    number of modified object saved
    
    Throws:
    
    FilePersistenceException
  - getNumberOfVisited
```
int getNumberOfVisited()
                       throws FilePersistenceException
```
    Returns:
    number of object visited for save
    
    Throws:
    
    FilePersistenceException
  - getStorageFileName
```
String getStorageFileName()
                          throws FilePersistenceException
```
    Returns:
    data storage file name
    
    Throws:
    
    FilePersistenceException
  - setAutoSaveEventListener
```
void setAutoSaveEventListener(IAutoSaveEventListener saveEventListener)
```
    set save event listener
    
    Parameters:
    saveEventListener - the save event listener
  - createDataAccessSession
```
IDataAccessSession createDataAccessSession()
                                           throws FilePersistenceException
```
    Returns:
    a new created data access session
    
    Throws:
    
    FilePersistenceException
  - createAloneDataAccessSession
```
@Deprecated
IAloneDataAccessSession createAloneDataAccessSession()
                                                     throws FilePersistenceException
```
    Deprecated.
    
    Returns:
    a new created alone data access session
    
    Throws:
    
    FilePersistenceException
  - createExclusiveDataAccessSession
```
IExclusiveDataAccessSession createExclusiveDataAccessSession()
                                                             throws FilePersistenceException
```
    Returns:
    a new created exclusive data access session
    
    Throws:
    
    FilePersistenceException
  - clear
```
void clear()
           throws FilePersistenceException,
                  FilePersistenceInvalidClassException,
                  FilePersistenceNotSerializableException,
                  FilePersistenceClassNotFoundException,
                  FilePersistenceDataCorruptedException
```
    clear all persisted data
    
    Throws:
    
    FilePersistenceException
    
    FilePersistenceInvalidClassException
    
    FilePersistenceNotSerializableException
    
    FilePersistenceClassNotFoundException
    
    FilePersistenceDataCorruptedException
  - copy
```
@Deprecated
Object copy(Object sourceObject)
            throws FilePersistenceException
```
    Deprecated.
    
    deprecated, see #deepCopy(Object)
    
    Parameters:
    sourceObject -
    
    Returns:
    deep copy of object
    
    Throws:
    
    FilePersistenceException
  - deepCopy
```
Object deepCopy(Object sourceObject,
              boolean forceLoad)
                throws FilePersistenceException
```
    deep copy of object, useful to detach from persistence ( proxy object to non-proxy, detached state if use java agent )
    
    Parameters:
    sourceObject -
    forceLoad - true if force proxy loading before copy
    
    Returns:
    deep copy of object
    
    Throws:
    
    FilePersistenceException
  - xmlExport
```
void xmlExport(String directoryName,
             String temporaryDirectoryName,
             boolean exportPersistedClassByteCode)
               throws FilePersistenceException,
                      FilePersistenceClassNotFoundException,
                      FilePersistenceInvalidClassException,
                      FilePersistenceDataCorruptedException,
                      FilePersistenceNotSerializableException,
                      FilePersistenceTooBigForSerializationException
```
    export persisted data in file export.xml put in directoryName directory can also export byte code of class of persisted object
    Parameters: directoryName - directory name where store export temporaryDirectoryName - temporary directory name used to store temporary files while exporting exportPersistedClassByteCode - true if export persisted class byte code Throws: FilePersistenceException FilePersistenceClassNotFoundException FilePersistenceInvalidClassException FilePersistenceDataCorruptedException FilePersistenceNotSerializableException FilePersistenceTooBigForSerializationException
  setExportListener void setExportListener(IExporterListener listener) getNumberOfObjectExported int getNumberOfObjectExported() xmlImport void xmlImport(String directoryName, boolean validating) throws FilePersistenceException, FilePersistenceClassNotFoundException, FilePersistenceInvalidClassException, FilePersistenceDataCorruptedException, FilePersistenceNotSerializableException import from exported data in directoryName directory Parameters: directoryName - directory name where are stored exported data to import validating - Throws: FilePersistenceException FilePersistenceClassNotFoundException FilePersistenceInvalidClassException FilePersistenceDataCorruptedException FilePersistenceNotSerializableException setClassLoader void setClassLoader(ClassLoader classLoader) throws FilePersistenceException set the class loader use by proxy creation to define class the class loader use by proxy creation to define class should be the same used to load class of object to be persisted Parameters: classLoader - Throws: FilePersistenceException getClassLoader ClassLoader getClassLoader() throws FilePersistenceException Returns: the class loader use by proxy creation to define class Throws: FilePersistenceException getResource URL getResource(String resourceName) throws MalformedURLException Throws: MalformedURLException newProxyInstance Object newProxyInstance(Object object) throws FilePersistenceException deep copy where all copy object are proxied if not enhanced by java agent see FilePersistence.targetCause(Exception) Parameters: object - object to copy where all instance will be replaced by proxy Returns: the proxied object Throws: FilePersistenceException newProxyInstance Object newProxyInstance(Class<?> objectClass, Class<?>[] parameterTypes, Object[] initargs) throws FilePersistenceException create object as proxy instance, deep copy of all member see FilePersistence.targetCause(Exception) Parameters: objectClass - the class of the object to create parameterTypes - parameters type, see Class.getConstructor(Class...) initargs - the construction parameters, see Constructor.newInstance(Object...) Returns: the proxied object as loaded proxy Throws: FilePersistenceException newProxyInstance Object newProxyInstance(Class<?> objectClass) throws FilePersistenceException Throws: FilePersistenceException setStoreOnlyMarkedStorable void setStoreOnlyMarkedStorable(boolean storeOnlyMarkedStorable) to specify if only class marked by StorableClass can be persisted or not Parameters: storeOnlyMarkedStorable - setSubstituteObjectManager void setSubstituteObjectManager(Class<?> objectClass, Class<?> substituteObjectClass, ISubstituteObjectManager substituteObjectManager) throws FilePersistenceException set substitution for object of a class writing and reading if class is not accessible see setSubstituteObjectManager(String, Class, ISubstituteObjectManager) Parameters: objectClass - the class of object to substitute substituteObjectClass - the substitute object class substituteObjectManager - the substitute manager to use Throws: FilePersistenceException setSubstituteObjectManager void setSubstituteObjectManager(String objectClassName, Class<?> substituteObjectClass, ISubstituteObjectManager substituteObjectManager) throws FilePersistenceException set substitution for object of a class writing and reading Parameters: objectClassName - the class by its name of object to substitute substituteObjectClass - the substitute object class substituteObjectManager - the substitute manager to use Throws: FilePersistenceException setNotPersistedField void setNotPersistedField(Class<?> clazz, String[] fieldNames) throws FilePersistenceException Parameters: clazz - fieldNames - Throws: FilePersistenceException setNotPersistedField void setNotPersistedField(String objectClassName, String[] fieldNames) throws FilePersistenceException Parameters: objectClassName - fieldNames - Throws: FilePersistenceException getClassIdentifier int getClassIdentifier(Class<?> clazz) throws FilePersistenceException, FilePersistenceClassNotFoundException Parameters: clazz - Returns: joafip internal class identifier Throws: FilePersistenceException FilePersistenceClassNotFoundException allClassInformation Collection<ClassInfo> allClassInformation() Returns: information on all knew classes isProxy boolean isProxy(Object object) to know if object is a proxy Parameters: object - the object to test Returns: true if object is a proxy keptInMemory void keptInMemory(String key, Object object) throws FilePersistenceException Inform that an object is kept in memory, never persisted since a persisted object can reference a kept in memory object a key is use to make able to recreate link between read from storage object and kept in memory object All instance of the object class can not be persisted (PROPS) can not be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: key - key associated to the object object - the not persisted object kept in memory Throws: FilePersistenceException referencedByPesistedStaticField void referencedByPesistedStaticField(Class<?> classHavingStaticFieldReferenced) throws FilePersistenceException instance referenced by static field of class are kept in memory Parameters: classHavingStaticFieldReferenced - Throws: FilePersistenceException referencedByPesistedStaticField void referencedByPesistedStaticField(Class<?>[] classHavingStaticFieldReferenced) throws FilePersistenceException instance referenced by static field of classes are kept in memory Parameters: classHavingStaticFieldReferenced - Throws: FilePersistenceException keyOfObjectKeptInMemory String keyOfObjectKeptInMemory(Object object) Parameters: object - the not persisted object kept in memory Returns: the key associated to the object setRecordSaveActions void setRecordSaveActions(boolean recordActions) activation of object write recording when saving see getWroteObjectSet() and getVisitedObjectSet() (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: recordActions - true to activate object write recording setRecordSaveActions void setRecordSaveActions(boolean recordActions, ISaveRecordActionListener saveRecordActionListener) setSaveRecordActionListener void setSaveRecordActionListener(ISaveRecordActionListener saveRecordActionListener) getWroteObjectSet Map<String,MutableInteger> getWroteObjectSet() see setRecordSaveActions(boolean) Returns: number of wrote object by class set since last save getVisitedObjectSet Set<String> getVisitedObjectSet() see setRecordSaveActions(boolean) Returns: visited object since last save getWroteArrays List<String> getWroteArrays() see setRecordSaveActions(boolean) Returns: wrote arrays setMaintainedInMemoryEnabled void setMaintainedInMemoryEnabled(boolean enabled) (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: enabled - true if enable maintain object in memory after save. see maintainInMemorySetup(int) maintainInMemorySetup void maintainInMemorySetup(int maintainedInMemoryQuota) (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: maintainedInMemoryQuota - maximum object maintained in memory ( not unload ) after a save setAutoSaveEnabled void setAutoSaveEnabled(boolean enabled) throws FilePersistenceException set auto save enabled (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: enabled - true if auto save enabled for exclusive data access session. see autoSaveSetup(int) Throws: FilePersistenceException isAutoSaveEnabled boolean isAutoSaveEnabled() Returns: true if auto save enabled autoSaveSetup void autoSaveSetup(int maxInMemoryThreshold) (PROPS) can be set using properties file see FilePersistence.FilePersistence(String, boolean) Parameters: maxInMemoryThreshold - maximum loaded object limit, save done when threshold is reach knownAsNotExisting ClassInfo knownAsNotExisting(String className) throws FilePersistenceClassNotFoundException, FilePersistenceException declare a class known as not existing Parameters: className - the class name Returns: the class information associated to the class by its name Throws: FilePersistenceClassNotFoundException FilePersistenceException classOfObject Class<?> classOfObject(Object object) throws FilePersistenceException Parameters: object - Returns: class of object, proxied class in case of proxy object Throws: FilePersistenceException classInfoOfObject ClassInfo classInfoOfObject(Object object) throws FilePersistenceException Throws: FilePersistenceException usedForClassNameManagement void usedForClassNameManagement(Set<DataRecordIdentifier> setToUpdate) throws FilePersistenceException Throws: FilePersistenceException close void close() throws FilePersistenceException close ( important to close files ) do not save modification Throws: FilePersistenceException isClosed boolean isClosed() isOpened boolean isOpened()

Interface IFilePersistence

Method Summary

Method Detail

setChangeLogEnabled

setZipCompressionLevel

setGarbageListener

setSubstitutionOfJavaUtilCollection

setWriteSubstitution

removeWriteSubstitution

setWriteSubstitution

removeWriteSubstitution

setNoLazyLoad

setNoLazyLoad

setNoLazyLoad

setNoLazyLoad

setStoreNotUseStandardSerialization

setStoreNotUseStandardSerialization

setStoreNotUseStandardSerialization

setStoreNotUseStandardSerialization

setStoreSerializeAndGZippedInOneRecord

setStoreSerializeAndGZippedInOneRecord

setStoreSerializeAndGZippedInOneRecord

setStoreSerializeAndGZippedInOneRecord

setStoreSerializeAndZippedInOneRecord

setStoreSerializeAndZippedInOneRecord

setStoreSerializeAndZippedInOneRecord

setStoreSerializeAndZippedInOneRecord

setStoreSerializeInOneRecord

setStoreSerializeInOneRecord

setStoreSerializeInOneRecord

setStoreSerializeInOneRecord

setStorable

setStorable

setStorable

setStorable

setNotStorable

setNotStorable

setNotStorable

setNotStorable

setDeprecatedInStore

setDeprecatedInStore

setDeprecatedInStore

setDeprecatedInStore

setForceEnhance

setForceEnhance

setForceEnhance

setForceEnhance

addProhibitedPackage

addToNotCheckMethod

addToNotCheckMethod

addToNotCheckMethod

addToNotCheckMethod

setObjectIOForClass

setObjectIOForClass

storedMutableEnum

setImportListener

storedMutableEnum

storedImmutableEnum

storedImmutableEnum

storedEnum

storedEnum

storedEnum

isGarbageManagement

garbageSweep

enableBackgroundGarbageSweep

disableBackgroundGarbageSweep

getNumberOfGarbageCandidate

getNumberOfToGarbage

getNumberOfDataRecord

getNumberOfFreeRecord

usedSize

freeSize

totalSize

getNumberOfObjectState

getNumberOfWeakReference

getNumberOfReferenced

getNumberOfModified

getNumberOfVisited

getStorageFileName

setAutoSaveEventListener