dk.heick.caching.persistences.file.xml

Class DefaultFilenameXmlFileValueManager<V>

java.lang.Object

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

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

dk.heick.caching.persistences.file.AbstractFilenameFileValueManager<V>

dk.heick.caching.persistences.file.xml.DefaultFilenameXmlFileValueManager<V>

Type Parameters:

V - the value V, which can stored and loaded using JAXB.

All Implemented Interfaces:

ValueManager<String,V>

public final class DefaultFilenameXmlFileValueManager<V>
extends AbstractFilenameFileValueManager<V>

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

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
DefaultFilenameXmlFileValueManager(CachingDirectory cachingDirectory, Class<V> xmlClazz, PersistencesRestoreMethod persistencesRestoreMethod) Constructor.

Method Summary

Modifier and Type	Method and Description
Class<V>	getXmlClazz() The class name of V.
V	retrieveFileValue(DefaultFileValueWrapper<String,V> valueWrapper) Loads the value from the file in valueWrapper.
void	storeFileValue(DefaultFileValueWrapper<String,V> valueWrapper, String 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.AbstractFilenameFileValueManager

constructFile, flush, 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

DefaultFilenameXmlFileValueManager

public DefaultFilenameXmlFileValueManager(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<String,V> valueWrapper)

Description copied from class: AbstractFilenameFileValueManager

Loads the value from the file in valueWrapper.

Specified by:

retrieveFileValue in class AbstractFilenameFileValueManager<V>

Parameters:

valueWrapper - the value wrapper

Returns:

the value V.

storeFileValue

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

Description copied from class: AbstractFilenameFileValueManager

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

Specified by:

storeFileValue in class AbstractFilenameFileValueManager<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.