com.helger.commons.jaxb

Class JAXBContextCache

java.lang.Object

com.helger.commons.cache.AbstractCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCache<JAXBContextCacheKey,JAXBContext>

com.helger.commons.jaxb.JAXBContextCache

All Implemented Interfaces:

ICache<JAXBContextCacheKey,JAXBContext>, IMutableCache<JAXBContextCacheKey,JAXBContext>, IHasSize, IHasName

@ThreadSafe
@Singleton
public final class JAXBContextCache
extends AbstractNotifyingCache<JAXBContextCacheKey,JAXBContext>

Specific cache class for JAXB context elements. This is helpful, as the JAXB context creation is a very time consuming task.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.commons.cache.AbstractCache

m_aCacheAccessStats, m_aRWLock, STATISTICS_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
JAXBContext	getFromCache(Class<?> aClass) Get the JAXBContext from an existing Class object.
JAXBContext	getFromCache(Class<?> aClass, ClassLoader aClassLoader) Get the JAXBContext from an existing Class object.
JAXBContext	getFromCache(Package aPackage) Special overload with package and default ClassLoader.
JAXBContext	getFromCache(Package aPackage, ClassLoader aClassLoader) Special overload with package and ClassLoader.
static JAXBContextCache	getInstance()
JAXBContext	getValueToCache(JAXBContextCacheKey aCacheKey) This abstract method is invoked, once a new value needs to be put into the cache.
static boolean	isInstantiated()
EChange	removeFromCache(Package aPackage)

Methods inherited from class com.helger.commons.cache.AbstractNotifyingCache

getFromCache

Methods inherited from class com.helger.commons.cache.AbstractCache

clearCache, createCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getFromCacheNotLocked, getMaxSize, getName, getSize, hasMaxSize, isEmpty, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, toString

Methods inherited from class java.lang.Object

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

Method Detail

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static JAXBContextCache getInstance()

getValueToCache

@Nullable
@IsLocked(value=WRITE)
public JAXBContext getValueToCache(@Nullable
                                                      JAXBContextCacheKey aCacheKey)

Description copied from class: AbstractNotifyingCache

This abstract method is invoked, once a new value needs to be put into the cache. This method is invoked within a locked section.

Specified by:

getValueToCache in class AbstractNotifyingCache<JAXBContextCacheKey,JAXBContext>

Parameters:

aCacheKey - The key for which the value to cache is required. May be nullable or not - depends upon the implementation.

Returns:

The value to be cached. May not be null.

getFromCache

@Nullable
public JAXBContext getFromCache(@Nonnull
                                Package aPackage)

Special overload with package and default ClassLoader.

Parameters:

aPackage - Package to load. May not be null.

Returns:

null if package is null.

getFromCache

@Nullable
public JAXBContext getFromCache(@Nonnull
                                Package aPackage,
                                @Nullable
                                ClassLoader aClassLoader)

Special overload with package and ClassLoader. In this case the resulting value is NOT cached!

Parameters:

aPackage - Package to load. May not be null.

aClassLoader - Class loader to use. May be null in which case the default class loader is used.

Returns:

null if package is null.

getFromCache

@Nonnull
public JAXBContext getFromCache(@Nonnull
                               Class<?> aClass)

Get the JAXBContext from an existing Class object. If the class's owning package is a valid JAXB package, this method redirects to getFromCache(Package) otherwise a new JAXB context is created and NOT cached.

Parameters:

aClass - The class for which the JAXB context is to be created. May not be null.

Returns:

Never null.

getFromCache

@Nonnull
public JAXBContext getFromCache(@Nonnull
                               Class<?> aClass,
                               @Nullable
                               ClassLoader aClassLoader)

Get the JAXBContext from an existing Class object. If the class's owning package is a valid JAXB package, this method redirects to getFromCache(Package) otherwise a new JAXB context is created and NOT cached.

Parameters:

aClass - The class for which the JAXB context is to be created. May not be null.

aClassLoader - Class loader to use. May be null in which case the default class loader is used.

Returns:

Never null.

removeFromCache

@Nonnull
public EChange removeFromCache(@Nonnull
                              Package aPackage)