dk.heick.caching.persistences.file.xml

Class DefaultIndexedXmlFileValueManager<K extends Serializable,V>

java.lang.Object

dk.heick.caching.persistences.AbstractPersistenceValueManager<K,V>

dk.heick.caching.persistences.file.AbstractFileValueManager<K,V>

dk.heick.caching.persistences.file.AbstractIndexedFileValueManager<K,V>

dk.heick.caching.persistences.file.xml.DefaultIndexedXmlFileValueManager<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

ValueManager<K,V>

public class DefaultIndexedXmlFileValueManager<K extends Serializable,V>
extends AbstractIndexedFileValueManager<K,V>

The default implementation of AbstractIndexedFileValueManager which stores the value as XML files.

Since:

1.0

Author:

Frederik Heick

See Also:

XmlUtils.writeXmlToFile(java.io.File, Object), XmlUtils.readXmlFromFile(java.io.File, Class)

Field Summary

Fields inherited from class dk.heick.caching.persistences.file.AbstractIndexedFileValueManager

PERSISTENCE_STORAGE_INDEX_FILE, PERSISTENCE_STORAGE_INDEX_FILENAME

Constructor Summary

Constructors

Constructor and Description
DefaultIndexedXmlFileValueManager(CachingDirectory cachingDirectory, Class<V> xmlClazz, PersistencesRestoreMethod persistencesRestoreMethod, int indexSaveInterval) Constructor.

Method Summary

Modifier and Type	Method and Description
Class<V>	getXmlClazz() The class name of V.
V	retrieveFileValue(DefaultFileValueWrapper<K,V> valueWrapper) Loads the value from the file in valueWrapper.
void	storeFileValue(DefaultFileValueWrapper<K,V> valueWrapper, K key, V value) This method shall the take the Value and stored it in a file given by the valueWrapper.

Methods inherited from class dk.heick.caching.persistences.file.AbstractIndexedFileValueManager

constructFile, flush, getIndexSaveInterval, reconstructKey, removeAll, removeValue, retrieveValue, storeValue

Methods inherited from class dk.heick.caching.persistences.file.AbstractFileValueManager

cast, constructWrapper, getCachingDirectory, getFile, restore, updateExpireTime

Methods inherited from class dk.heick.caching.persistences.AbstractPersistenceValueManager

getLogger, getPersistencesRestoreMethod, isPersisted

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexedXmlFileValueManager

public DefaultIndexedXmlFileValueManager(CachingDirectory cachingDirectory,
                                         Class<V> xmlClazz,
                                         PersistencesRestoreMethod persistencesRestoreMethod,
                                         int indexSaveInterval)
                                  throws NullPointerException,
                                         IllegalArgumentException

Constructor.

Parameters:

cachingDirectory - the directory where to store the cached values.

xmlClazz - the class name of V.

persistencesRestoreMethod - the restore method, when reconstructing the LRUCachingMap.

indexSaveInterval - how many changes (put,remove) must occur before the key/file index file is saved, allways forced save after (restore and cleanup)

Throws:

IllegalArgumentException - if cacheDirectory isnt a valid directory or if xmlClazz is not annotated with "@XmlRootElement".

NullPointerException - if cachingDirectory, xmlClazz,or persistencesRestoreMethod is null.

Method Detail

getXmlClazz

public final Class<V> getXmlClazz()

The class name of V.

Returns:

the class name of V.

storeFileValue

public void storeFileValue(DefaultFileValueWrapper<K,V> valueWrapper,
                           K key,
                           V value)
                    throws RuntimeException

Description copied from class: AbstractIndexedFileValueManager

This method shall the take the Value and stored it in a file given by the valueWrapper.

Specified by:

storeFileValue in class AbstractIndexedFileValueManager<K extends Serializable,V>

Parameters:

valueWrapper - the value wrapper which holds the file.

key - the key.

value - the value.

Throws:

RuntimeException - if the value can not be stored in the file.

retrieveFileValue

public V retrieveFileValue(DefaultFileValueWrapper<K,V> valueWrapper)

Description copied from class: AbstractIndexedFileValueManager

Loads the value from the file in valueWrapper.

Specified by:

retrieveFileValue in class AbstractIndexedFileValueManager<K extends Serializable,V>

Parameters:

valueWrapper - the value wrapper

Returns:

the value V.