dk.heick.caching.persistences.file.xml

Class DefaultKeyedXmlFileValueManager<K extends Serializable,V extends Keyed<K>>

java.lang.Object

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

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

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

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

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

ValueManager<K,V>

public final class DefaultKeyedXmlFileValueManager<K extends Serializable,V extends Keyed<K>>
extends AbstractKeyedFileValueManager<K,V>

This ValueManager will save and load the value V to a file using JAXB.
This requries that V class has the annotation @XmlRootElement.
This requries that V implements Keyed.

Since:

1.0

Author:

Frederik Heick

See Also:

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	flush() This is ensures that any memory data that needs to be persisted is flushed.
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.AbstractKeyedFileValueManager

constructFile, reconstructKey, retrieveValue, storeValue

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

cast, constructWrapper, getCachingDirectory, getFile, removeAll, removeValue, 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

DefaultKeyedXmlFileValueManager

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

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.

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.

retrieveFileValue

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

Description copied from class: AbstractKeyedFileValueManager

Loads the value from the file in valueWrapper.

Specified by:

retrieveFileValue in class AbstractKeyedFileValueManager<K extends Serializable,V extends Keyed<K>>

Parameters:

valueWrapper - the value wrapper

Returns:

the value V.

storeFileValue

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

Description copied from class: AbstractKeyedFileValueManager

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

Specified by:

storeFileValue in class AbstractKeyedFileValueManager<K extends Serializable,V extends Keyed<K>>

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.

flush

public void flush()

Description copied from class: AbstractKeyedFileValueManager

This is ensures that any memory data that needs to be persisted is flushed.
This is the case with Indexed value managers.
This method must be called by the LRUCachingMap implementation after "cleanup" and after "restore". Does nothing.

Specified by:

flush in interface ValueManager<K extends Serializable,V extends Keyed<K>>

Overrides:

flush in class AbstractKeyedFileValueManager<K extends Serializable,V extends Keyed<K>>

See Also:

LRUCachingMap.cleanup(), ValueManager.restore(LRUCachingMap)