org.cache2k

Class CacheManager

java.lang.Object

org.cache2k.CacheManager

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Cache>

public abstract class CacheManager
extends Object
implements Iterable<Cache>, Closeable

Author:

Jens Wilke; created: 2013-06-27

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_MANAGER_NAME

Constructor Summary

Constructors

Constructor and Description
CacheManager()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	clear() Clear all caches associated to this cache manager
abstract void	close() Free all resources from managed caches.
abstract void	destroy() Deprecated. Use close()
abstract Cache	getCache(String name)
static String	getDefaultName() Name of the default cache manager, which is "default" by default.
static CacheManager	getInstance() Get the default cache manager for the current class loader
static CacheManager	getInstance(String _name)
abstract String	getName()
abstract boolean	isDestroyed()
abstract Iterator<Cache>	iterator()
static void	setDefaultName(String defaultName) Reset the manager name once on application startup.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MANAGER_NAME

protected static final String DEFAULT_MANAGER_NAME

See Also:

Constant Field Values

Constructor Detail

CacheManager

public CacheManager()

Method Detail

getDefaultName

public static String getDefaultName()

Name of the default cache manager, which is "default" by default. It is also possible to set the default manager name via JNDI context "java:comp/env" and name "org.cache2k.CacheManager.defaultName".

setDefaultName

public static void setDefaultName(String defaultName)

Reset the manager name once on application startup.

getInstance

public static CacheManager getInstance()

Get the default cache manager for the current class loader

getInstance

public static CacheManager getInstance(String _name)

getName

public abstract String getName()

iterator

public abstract Iterator<Cache> iterator()

Specified by:

iterator in interface Iterable<Cache>

getCache

public abstract Cache getCache(String name)

clear

public abstract void clear()

Clear all caches associated to this cache manager

destroy

public abstract void destroy()

Deprecated. Use close()

close

public abstract void close()

Free all resources from managed caches. If there is unwritten data, it is flushed, if needed. Same as calling all Cache.close() methods. Calling this method is more effective, since it tries to close all caches concurrently as fast as possible.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isDestroyed

public abstract boolean isDestroyed()