com.helger.jaxb

Class JAXBContextCache

java.lang.Object

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

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

com.helger.jaxb.JAXBContextCache

All Implemented Interfaces:

com.helger.commons.cache.ICache<JAXBContextCacheKey,JAXBContext>, com.helger.commons.cache.IMutableCache<JAXBContextCacheKey,JAXBContext>, com.helger.commons.lang.IHasSize, com.helger.commons.name.IHasName

@ThreadSafe
 @Singleton
public final class JAXBContextCache
extends com.helger.commons.cache.Cache<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.Cache

DEFAULT_ALLOW_NULL_VALUES

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

m_aRWLock, NO_MAX_SIZE, STATISTICS_PREFIX

Method Summary

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(com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses) Get the JAXBContext from existing Class objects.
JAXBContext	getFromCache(com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses, Map<String,?> aProperties) Get the JAXBContext from existing Class objects and optional JAXB Context properties.
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()
static boolean	isInstantiated()
static boolean	isSilentMode()
com.helger.commons.state.EChange	removeFromCache(com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses)
com.helger.commons.state.EChange	removeFromCache(com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses, Map<String,?> aProperties)
com.helger.commons.state.EChange	removeFromCache(Package aPackage)
com.helger.commons.state.EChange	removeFromCache(Package aPackage, ClassLoader aClassLoader)
static boolean	setSilentMode(boolean bSilentMode) Enable or disable certain regular log messages.

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

clearCache, createCache, getCacheKeyProvider, getFromCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getMaxSize, getName, getValueProvider, hasMaxSize, isAllowNullValues, isEmpty, isInCache, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, size, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Method Detail

isSilentMode

public static boolean isSilentMode()

Returns:

true if logging is disabled, false if it is enabled.

Since:

9.4.0

setSilentMode

public static boolean setSilentMode(boolean bSilentMode)

Enable or disable certain regular log messages.

Parameters:

bSilentMode - true to disable logging, false to enable logging

Returns:

The previous value of the silent mode.

Since:

9.4.0

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static JAXBContextCache getInstance()

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

@Nullable
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:

May be null.

getFromCache

@Nullable
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).

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:

May be null.

getFromCache

@Nullable
public JAXBContext getFromCache(@Nonnull
                                           com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses)

Get the JAXBContext from existing Class objects.

Parameters:

aClasses - The classes for which the JAXB context is to be created. May not be null nor empty.

Returns:

May be null.

Since:

v9.4.2

getFromCache

@Nullable
public JAXBContext getFromCache(@Nonnull
                                           com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses,
                                           @Nullable
                                           Map<String,?> aProperties)

Get the JAXBContext from existing Class objects and optional JAXB Context properties.

Parameters:

aClasses - The classes for which the JAXB context is to be created. May not be null nor empty.

aProperties - JAXB context properties. May be null.

Returns:

May be null.

Since:

v9.4.2

removeFromCache

@Nonnull
public com.helger.commons.state.EChange removeFromCache(@Nonnull
                                                                  Package aPackage)

removeFromCache

@Nonnull
public com.helger.commons.state.EChange removeFromCache(@Nonnull
                                                                  Package aPackage,
                                                                  @Nullable
                                                                  ClassLoader aClassLoader)

removeFromCache

@Nonnull
public com.helger.commons.state.EChange removeFromCache(@Nonnull
                                                                  com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses)

removeFromCache

@Nonnull
public com.helger.commons.state.EChange removeFromCache(@Nonnull
                                                                  com.helger.commons.collection.impl.ICommonsList<Class<?>> aClasses,
                                                                  @Nullable
                                                                  Map<String,?> aProperties)