com.atlassian.cache.impl

Class AbstractCacheManager

java.lang.Object

com.atlassian.cache.impl.AbstractCacheManager

All Implemented Interfaces:

CacheFactory, CacheManager

@ParametersAreNonnullByDefault
public abstract class AbstractCacheManager
extends Object
implements CacheManager

A partial implementation of CacheManager.

Since:

2.0.6

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.util.concurrent.Function<String,com.atlassian.util.concurrent.ManagedLock>	cacheCreationLocks Used to synchronize the creation of caches.
protected ConcurrentMap<String,com.atlassian.util.concurrent.Supplier<ManagedCache>>	caches Map of all the caches.
protected CacheSettingsDefaultsProvider	cacheSettingsDefaultsProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCacheManager(CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider)

Method Summary

Modifier and Type	Method and Description
protected abstract <K,V> ManagedCache	createComputingCache(String name, CacheSettings settings, CacheLoader<K,V> loader) Creates a cache that upon a miss is able to populate itself using the loader.
protected abstract ManagedCache	createSimpleCache(String name, CacheSettings settings) Creates a cache with no loader, i.e.
void	flushCaches()
<K,V> Cache<K,V>	getCache(Class<?> owningClass, String name)
<K,V> Cache<K,V>	getCache(String name)
<K,V> Cache<K,V>	getCache(String name, CacheLoader<K,V> loader)
<K,V> Cache<K,V>	getCache(String name, CacheLoader<K,V> loader, CacheSettings settings)
<K,V> Cache<K,V>	getCache(String name, Class<K> keyType, Class<V> valueType)
<V> CachedReference<V>	getCachedReference(Class<?> owningClass, String name, Supplier<V> supplier)
<V> CachedReference<V>	getCachedReference(Class<?> owningClass, String name, Supplier<V> supplier, CacheSettings settings)
<V> CachedReference<V>	getCachedReference(String name, Supplier<V> supplier)
Collection<Cache<?,?>>	getCaches()
ManagedCache	getManagedCache(String name)
Collection<ManagedCache>	getManagedCaches()
protected CacheSettings	mergeSettings(String name, CacheSettings settings)
void	shutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.cache.CacheFactory

getCachedReference

Field Detail

caches

protected final ConcurrentMap<String,com.atlassian.util.concurrent.Supplier<ManagedCache>> caches

Map of all the caches. Before creating a cache to put into the map, acquire a lock using cacheCreationLocks to ensure that a cache is created only once.

cacheCreationLocks

protected final com.atlassian.util.concurrent.Function<String,com.atlassian.util.concurrent.ManagedLock> cacheCreationLocks

Used to synchronize the creation of caches.

cacheSettingsDefaultsProvider

@Nullable
protected final CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider

Constructor Detail

AbstractCacheManager

protected AbstractCacheManager(@Nullable
                               CacheSettingsDefaultsProvider cacheSettingsDefaultsProvider)

Method Detail

getCaches

@Nonnull
public Collection<Cache<?,?>> getCaches()

Specified by:

getCaches in interface CacheManager

getManagedCaches

@Nonnull
public Collection<ManagedCache> getManagedCaches()

Specified by:

getManagedCaches in interface CacheManager

getManagedCache

@Nullable
public ManagedCache getManagedCache(@Nonnull
                                              String name)

Specified by:

getManagedCache in interface CacheManager

flushCaches

public void flushCaches()

Specified by:

flushCaches in interface CacheManager

getCache

@Nonnull
public <K,V> Cache<K,V> getCache(@Nonnull
                                          String name)

Specified by:

getCache in interface CacheFactory

getCache

@Nonnull
public <K,V> Cache<K,V> getCache(@Nonnull
                                          Class<?> owningClass,
                                          @Nonnull
                                          String name)

Specified by:

getCache in interface CacheFactory

getCache

@Nonnull
public <K,V> Cache<K,V> getCache(@Nonnull
                                          String name,
                                          @Nonnull
                                          Class<K> keyType,
                                          @Nonnull
                                          Class<V> valueType)

Specified by:

getCache in interface CacheFactory

getCache

@Nonnull
public <K,V> Cache<K,V> getCache(@Nonnull
                                          String name,
                                          @Nullable
                                          CacheLoader<K,V> loader)

Specified by:

getCache in interface CacheFactory

getCachedReference

@Nonnull
public <V> CachedReference<V> getCachedReference(@Nonnull
                                                          String name,
                                                          @Nonnull
                                                          Supplier<V> supplier)

Specified by:

getCachedReference in interface CacheFactory

getCachedReference

@Nonnull
public <V> CachedReference<V> getCachedReference(@Nonnull
                                                          Class<?> owningClass,
                                                          @Nonnull
                                                          String name,
                                                          @Nonnull
                                                          Supplier<V> supplier)

Specified by:

getCachedReference in interface CacheFactory

getCachedReference

@Nonnull
public <V> CachedReference<V> getCachedReference(@Nonnull
                                                          Class<?> owningClass,
                                                          @Nonnull
                                                          String name,
                                                          @Nonnull
                                                          Supplier<V> supplier,
                                                          @Nonnull
                                                          CacheSettings settings)

Specified by:

getCachedReference in interface CacheFactory

getCache

@Nonnull
public <K,V> Cache<K,V> getCache(@Nonnull
                                          String name,
                                          @Nullable
                                          CacheLoader<K,V> loader,
                                          @Nonnull
                                          CacheSettings settings)

Specified by:

getCache in interface CacheFactory

createComputingCache

protected abstract <K,V> ManagedCache createComputingCache(@Nonnull
                                                           String name,
                                                           @Nonnull
                                                           CacheSettings settings,
                                                           @Nullable
                                                           CacheLoader<K,V> loader)

Creates a cache that upon a miss is able to populate itself using the loader.

Returns:

a non-null cache

createSimpleCache

protected abstract ManagedCache createSimpleCache(@Nonnull
                                                  String name,
                                                  @Nonnull
                                                  CacheSettings settings)

Creates a cache with no loader, i.e. one populated via explicit puts.

Parameters:

name - the name to give the cache (required)

Returns:

a non-null cache

mergeSettings

protected CacheSettings mergeSettings(String name,
                                      CacheSettings settings)

shutdown

public void shutdown()

Specified by:

shutdown in interface CacheManager