Spring Framework 6.1.4 · org.springframework.cache.support.AbstractCacheManager

Modifier and Type	Field and Description
private final ConcurrentMap<String, Cache>	cacheMap
private volatile Set<String>	cacheNames

Access	Constructor and Description
public	AbstractCacheManager()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected Cache	Returns: the decorated Cache object to be used instead, or simply the passed-in Cache object by default decorateCache(Cache the Cache object to be added to this CacheManager cache) Decorate the given Cache object if necessary.
public Cache	getCache(String the cache identifier (must not be `null`) name) Implements org.springframework.cache.CacheManager.getCache. Get the cache associated with the given name.
public Collection<String>	getCacheNames() Implements org.springframework.cache.CacheManager.getCacheNames. Get a collection of the cache names known by this manager.
protected Cache	Returns: the missing cache, or `null` if no such cache exists or could be created on demand getMissingCache(String the name of the cache to retrieve name) Return a missing cache with the specified `name`, or `null` if such a cache does not exist or could not be created on demand.
public void	initializeCaches() Initialize the static configuration of caches.
protected abstract Collection<? extends Cache>	loadCaches() Load the initial caches for this cache manager.
protected final Cache	Returns: the associated Cache instance, or `null` if none found lookupCache(String the cache identifier (must not be `null`) name) Check for a registered cache of the given name.
private void	updateCacheNames(String the name of the cache to be added name) Update the exposed `cacheNames` set with the given name.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

cacheMap	back to summary
private final ConcurrentMap<String, Cache> cacheMap

cacheNames	back to summary
private volatile Set<String> cacheNames

AbstractCacheManager	back to summary
public AbstractCacheManager()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

decorateCache	back to summary
protected Cache decorateCache(Cache cache) Decorate the given Cache object if necessary. Parameters cache:Cache the Cache object to be added to this CacheManager Returns:Cache the decorated Cache object to be used instead, or simply the passed-in Cache object by default

decorateCache

back to summary

protected Cache decorateCache(Cache cache)

Decorate the given Cache object if necessary.

Parameters

cache:Cache: the Cache object to be added to this CacheManager

Returns:Cache

the decorated Cache object to be used instead, or simply the passed-in Cache object by default

getCache back to summary

getCache	back to summary
public Cache getCache(String name) Implements org.springframework.cache.CacheManager.getCache. Doc from org.springframework.cache.CacheManager.getCache. Get the cache associated with the given name. Note that the cache may be lazily created at runtime if the native provider supports it. Parameters name:String the cache identifier (must not be `null`) Returns:Cache the associated cache, or `null` if such a cache does not exist or could be not created Annotations @Override @Nullable

public Cache getCache(String name)

Implements org.springframework.cache.CacheManager.getCache.

Doc from org.springframework.cache.CacheManager.getCache.

Get the cache associated with the given name.

Note that the cache may be lazily created at runtime if the native provider supports it.

Parameters

name:String: the cache identifier (must not be null)

Returns:Cache

the associated cache, or null if such a cache does not exist or could be not created

Annotations

@Override
@Nullable

getCacheNames	back to summary
public Collection<String> getCacheNames() Implements org.springframework.cache.CacheManager.getCacheNames. Doc from org.springframework.cache.CacheManager.getCacheNames. Get a collection of the cache names known by this manager. Returns:Collection<String> the names of all caches known by the cache manager Annotations @Override

getCacheNames

back to summary

public Collection<String> getCacheNames()

Implements org.springframework.cache.CacheManager.getCacheNames.

Doc from org.springframework.cache.CacheManager.getCacheNames.

Get a collection of the cache names known by this manager.

Returns:Collection<String>

the names of all caches known by the cache manager

Annotations

@Override

getMissingCache back to summary

getMissingCache	back to summary
protected Cache getMissingCache(String name) Return a missing cache with the specified `name`, or `null` if such a cache does not exist or could not be created on demand. Caches may be lazily created at runtime if the native provider supports it. If a lookup by name does not yield any result, an `AbstractCacheManager` subclass gets a chance to register such a cache at runtime. The returned cache will be automatically added to this cache manager. Parameters name:String the name of the cache to retrieve Returns:Cache the missing cache, or `null` if no such cache exists or could be created on demand Annotations @Nullable Since 4.1 See Also `getCache(String)`

protected Cache getMissingCache(String name)

Return a missing cache with the specified name, or null if such a cache does not exist or could not be created on demand.

Caches may be lazily created at runtime if the native provider supports it. If a lookup by name does not yield any result, an AbstractCacheManager subclass gets a chance to register such a cache at runtime. The returned cache will be automatically added to this cache manager.

Parameters

name:String: the name of the cache to retrieve

Returns:Cache

the missing cache, or null if no such cache exists or could be created on demand

Annotations

@Nullable

Since

4.1

See Also

getCache(String)

initializeCaches back to summary

initializeCaches	back to summary
public void initializeCaches() Initialize the static configuration of caches. Triggered on startup through `afterPropertiesSet()`; can also be called to re-initialize at runtime. Since 4.2.2 See Also `loadCaches()`

public void initializeCaches()

Initialize the static configuration of caches.

Triggered on startup through afterPropertiesSet(); can also be called to re-initialize at runtime.

Since: 4.2.2
See Also: loadCaches()

loadCaches back to summary

loadCaches	back to summary
protected abstract Collection<? extends Cache> loadCaches() Load the initial caches for this cache manager. Called by `afterPropertiesSet()` on startup. The returned collection may be empty but must not be `null`.

protected abstract Collection<? extends Cache> loadCaches()

Load the initial caches for this cache manager.

Called by afterPropertiesSet() on startup. The returned collection may be empty but must not be null.

lookupCache back to summary

lookupCache	back to summary
protected final Cache lookupCache(String name) Check for a registered cache of the given name. In contrast to `getCache(String)`, this method does not trigger the lazy creation of missing caches via `getMissingCache(String)`. Parameters name:String the cache identifier (must not be `null`) Returns:Cache the associated Cache instance, or `null` if none found Annotations @Nullable Since 4.1 See Also `getCache(String)`, `getMissingCache(String)`

protected final Cache lookupCache(String name)

Check for a registered cache of the given name. In contrast to getCache(String), this method does not trigger the lazy creation of missing caches via getMissingCache(String).

Parameters

name:String: the cache identifier (must not be null)

Returns:Cache

the associated Cache instance, or null if none found

Annotations

@Nullable

Since

4.1

updateCacheNames back to summary

updateCacheNames	back to summary
private void updateCacheNames(String name) Update the exposed `cacheNames` set with the given name. This will always be called within a full `cacheMap` lock and effectively behaves like a `CopyOnWriteArraySet` with preserved order but exposed as an unmodifiable reference. Parameters name:String the name of the cache to be added

private void updateCacheNames(String name)

Update the exposed cacheNames set with the given name.

This will always be called within a full cacheMap lock and effectively behaves like a CopyOnWriteArraySet with preserved order but exposed as an unmodifiable reference.

Parameters

name:String: the name of the cache to be added

public abstract Class AbstractCacheManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail