Class DefaultContextCache
- java.lang.Object
- org.springframework.test.context.cache.DefaultContextCache
- All Implemented Interfaces:
ContextCache
public class DefaultContextCache extends Object implements ContextCache
Default implementation of theContextCache
API.Uses a synchronized
Map
configured with a maximum size and a least recently used (LRU) eviction policy to cacheApplicationContext
instances.The maximum size may be supplied as a constructor argument or set via a system property or Spring property named
spring.test.context.cache.maxSize
.- Since:
- 2.5
- Author:
- Sam Brannen, Juergen Hoeller
- See Also:
ContextCacheUtils.retrieveMaxCacheSize()
Field Summary
Fields inherited from interface org.springframework.test.context.cache.ContextCache
CONTEXT_CACHE_LOGGING_CATEGORY, DEFAULT_MAX_CONTEXT_CACHE_SIZE, MAX_CONTEXT_CACHE_SIZE_PROPERTY_NAME
Constructor Summary
Constructors Constructor Description DefaultContextCache()
Create a newDefaultContextCache
using the maximum cache size obtained viaContextCacheUtils.retrieveMaxCacheSize()
.DefaultContextCache(int maxSize)
Create a newDefaultContextCache
using the supplied maximum cache size.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear all contexts from the cache, clearing context hierarchy information as well.void
clearStatistics()
Clear hit and miss count statistics for the cache (i.e., reset counters to zero).boolean
contains(MergedContextConfiguration key)
Determine whether there is a cached context for the given key.ApplicationContext
get(MergedContextConfiguration key)
Obtain a cachedApplicationContext
for the given key.int
getHitCount()
Get the overall hit count for this cache.int
getMaxSize()
Get the maximum size of this cache.int
getMissCount()
Get the overall miss count for this cache.int
getParentContextCount()
Determine the number of parent contexts currently tracked within the cache.void
logStatistics()
Log the statistics for thisContextCache
atDEBUG
level using the "org.springframework.test.context.cache" logging category.void
put(MergedContextConfiguration key, ApplicationContext context)
Explicitly add anApplicationContext
instance to the cache under the given key, potentially honoring a custom eviction policy.void
remove(MergedContextConfiguration key, DirtiesContext.HierarchyMode hierarchyMode)
Remove the context with the given key from the cache and explicitly close it if it is an instance ofConfigurableApplicationContext
.void
reset()
Reset all state maintained by this cache including statistics.int
size()
Determine the number of contexts currently stored in the cache.String
toString()
Generate a text string containing the implementation type of this cache and its statistics.
Constructor Detail
DefaultContextCache
public DefaultContextCache()
Create a newDefaultContextCache
using the maximum cache size obtained viaContextCacheUtils.retrieveMaxCacheSize()
.- Since:
- 4.3
- See Also:
DefaultContextCache(int)
,ContextCacheUtils.retrieveMaxCacheSize()
DefaultContextCache
public DefaultContextCache(int maxSize)
Create a newDefaultContextCache
using the supplied maximum cache size.- Parameters:
maxSize
- the maximum cache size- Throws:
IllegalArgumentException
- if the suppliedmaxSize
value is not positive- Since:
- 4.3
- See Also:
DefaultContextCache()
Method Detail
contains
public boolean contains(MergedContextConfiguration key)
Determine whether there is a cached context for the given key.- Specified by:
contains
in interfaceContextCache
- Parameters:
key
- the context key (nevernull
)- Returns:
true
if the cache contains a context with the given key
get
@Nullable public ApplicationContext get(MergedContextConfiguration key)
Obtain a cachedApplicationContext
for the given key.- Specified by:
get
in interfaceContextCache
- Parameters:
key
- the context key (nevernull
)- Returns:
- the corresponding
ApplicationContext
instance, ornull
if not found in the cache - See Also:
ContextCache.remove(org.springframework.test.context.MergedContextConfiguration, org.springframework.test.annotation.DirtiesContext.HierarchyMode)
put
public void put(MergedContextConfiguration key, ApplicationContext context)
Explicitly add anApplicationContext
instance to the cache under the given key, potentially honoring a custom eviction policy.- Specified by:
put
in interfaceContextCache
- Parameters:
key
- the context key (nevernull
)context
- theApplicationContext
instance (nevernull
)
remove
public void remove(MergedContextConfiguration key, @Nullable DirtiesContext.HierarchyMode hierarchyMode)
Remove the context with the given key from the cache and explicitly close it if it is an instance ofConfigurableApplicationContext
.Generally speaking, this method should be called to properly evict a context from the cache (e.g., due to a custom eviction policy) or if the state of a singleton bean has been modified, potentially affecting future interaction with the context.
In addition, the semantics of the supplied
HierarchyMode
must be honored. See the Javadoc forDirtiesContext.HierarchyMode
for details.- Specified by:
remove
in interfaceContextCache
- Parameters:
key
- the context key; nevernull
hierarchyMode
- the hierarchy mode; may benull
if the context is not part of a hierarchy
size
public int size()
Determine the number of contexts currently stored in the cache.If the cache contains more than
Integer.MAX_VALUE
elements, this method must returnInteger.MAX_VALUE
.- Specified by:
size
in interfaceContextCache
getMaxSize
public int getMaxSize()
Get the maximum size of this cache.
getParentContextCount
public int getParentContextCount()
Determine the number of parent contexts currently tracked within the cache.- Specified by:
getParentContextCount
in interfaceContextCache
getHitCount
public int getHitCount()
Get the overall hit count for this cache.A hit is any access to the cache that returns a non-null context for the queried key.
- Specified by:
getHitCount
in interfaceContextCache
getMissCount
public int getMissCount()
Get the overall miss count for this cache.A miss is any access to the cache that returns a
null
context for the queried key.- Specified by:
getMissCount
in interfaceContextCache
reset
public void reset()
Reset all state maintained by this cache including statistics.- Specified by:
reset
in interfaceContextCache
- See Also:
ContextCache.clear()
,ContextCache.clearStatistics()
clear
public void clear()
Clear all contexts from the cache, clearing context hierarchy information as well.- Specified by:
clear
in interfaceContextCache
clearStatistics
public void clearStatistics()
Clear hit and miss count statistics for the cache (i.e., reset counters to zero).- Specified by:
clearStatistics
in interfaceContextCache
logStatistics
public void logStatistics()
Log the statistics for thisContextCache
atDEBUG
level using the "org.springframework.test.context.cache" logging category.The following information should be logged.
- name of the concrete
ContextCache
implementation - ContextCache.size()
- parent context count
- hit count
- miss count
- any other information useful for monitoring the state of this cache
- Specified by:
logStatistics
in interfaceContextCache
- name of the concrete
toString
public String toString()
Generate a text string containing the implementation type of this cache and its statistics.The string returned by this method contains all information required for compliance with the contract for
logStatistics()
.