org.cache2k

Class CacheBuilder<K,T>

java.lang.Object

org.cache2k.BaseAnyBuilder<K,T,CacheConfig>

org.cache2k.RootAnyBuilder<K,T>

org.cache2k.CacheBuilder<K,T>

All Implemented Interfaces:

Cloneable, AnyBuilder<K,T,CacheConfig>

public abstract class CacheBuilder<K,T>
extends RootAnyBuilder<K,T>
implements Cloneable

Author:

Jens Wilke; created: 2013-06-25

Field Summary

Fields

Modifier and Type	Field and Description
protected BulkCacheSource	bulkCacheSource
protected CacheSource	cacheSource
protected CacheSourceWithMetaInfo	cacheSourceWithMetaInfo
protected EntryExpiryCalculator	entryExpiryCalculator
protected ExceptionExpiryCalculator	exceptionExpiryCalculator
protected ExperimentalBulkCacheSource	experimentalBulkCacheSource
protected RefreshController	refreshController

Fields inherited from class org.cache2k.RootAnyBuilder

config

Fields inherited from class org.cache2k.BaseAnyBuilder

root

Constructor Summary

Constructors

Constructor and Description
CacheBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Cache<K,T>	build() Builds a cache with the specified configuration parameters.
protected void	ctor(Class<K> _keyType, Class<T> _valueType, Class<?> _entryType) Builder is constructed from prototype
CacheBuilder<K,T>	entryExpiryCalculator(EntryExpiryCalculator c) Set expiry calculator to use.
CacheBuilder<K,T>	eternal(boolean v) Keep entries forever.
CacheBuilder<K,T>	exceptionExpiryCalculator(ExceptionExpiryCalculator c) Set expiry calculator to use in case of an exception happened in the CacheSource.
CacheBuilder<K,T>	exceptionExpiryDuration(long v, TimeUnit u) Separate timeout in the case an exception was thrown in the cache source.
CacheBuilder<K,T>	expiryDuration(long v, TimeUnit u) Set the time duration after an entry expires.
CacheBuilder<K,T>	expiryMillis(long v) Deprecated. since 0.20, please use expiryDuration(long, java.util.concurrent.TimeUnit)
CacheBuilder<K,T>	expirySecs(int v) Deprecated. since 0.20, please use expiryDuration(long, java.util.concurrent.TimeUnit)
CacheConfig	getConfig() Deprecated.
CacheBuilder<K,T>	heapEntryCapacity(int v)
CacheBuilder<K,T>	implementation(Class<?> c)
CacheBuilder<K,T>	keepDataAfterExpired(boolean v)
CacheBuilder<K,T>	maxSize(int v)
CacheBuilder<K,T>	maxSizeBound(int v)
CacheBuilder<K,T>	name(Class<?> _class)
CacheBuilder<K,T>	name(Class<?> _class, String _fieldName) Constructs a cache name out of the simple class name and fieldname.
CacheBuilder<K,T>	name(Object _containingObject, String _fieldName) Constructs a cache name out of the simple class name and fieldname.
CacheBuilder<K,T>	name(String v)
static <K,C extends Collection<T>,T> CacheBuilder<K,C>	newCache(Class<K> _keyType, Class<C> _collectionType, Class<T> _entryType)
static <K,T> CacheBuilder<K,T>	newCache(Class<K> _keyType, Class<T> _valueType)
CacheBuilder<K,T>	refreshController(RefreshController c) Deprecated. since 0.20, please use entryExpiryCalculator
CacheBuilder<K,T>	source(BulkCacheSource<K,T> g)
CacheBuilder<K,T>	source(CacheSource<K,T> g)
CacheBuilder<K,T>	source(CacheSourceWithMetaInfo<K,T> g)
CacheBuilder<K,T>	source(ExperimentalBulkCacheSource<K,T> g)
CacheBuilder<K,T>	suppressExceptions(boolean v) If an exceptions gets thrown by the cache source, suppress it if there is a previous value.

Methods inherited from class org.cache2k.RootAnyBuilder

backgroundRefresh, createConfiguration, persistence, sharpExpiry

Methods inherited from class org.cache2k.BaseAnyBuilder

root

Methods inherited from class java.lang.Object

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

Field Detail

entryExpiryCalculator

protected EntryExpiryCalculator entryExpiryCalculator

cacheSource

protected CacheSource cacheSource

cacheSourceWithMetaInfo

protected CacheSourceWithMetaInfo cacheSourceWithMetaInfo

refreshController

protected RefreshController refreshController

experimentalBulkCacheSource

protected ExperimentalBulkCacheSource experimentalBulkCacheSource

bulkCacheSource

protected BulkCacheSource bulkCacheSource

exceptionExpiryCalculator

protected ExceptionExpiryCalculator exceptionExpiryCalculator

Constructor Detail

CacheBuilder

public CacheBuilder()

Method Detail

newCache

public static <K,T> CacheBuilder<K,T> newCache(Class<K> _keyType,
                               Class<T> _valueType)

newCache

public static <K,C extends Collection<T>,T> CacheBuilder<K,C> newCache(Class<K> _keyType,
                                                       Class<C> _collectionType,
                                                       Class<T> _entryType)

ctor

protected void ctor(Class<K> _keyType,
        Class<T> _valueType,
        Class<?> _entryType)

Builder is constructed from prototype

name

public CacheBuilder<K,T> name(Class<?> _class,
                     String _fieldName)

Constructs a cache name out of the simple class name and fieldname. a cache name should be unique within an application / cache manager!

name

public CacheBuilder<K,T> name(Class<?> _class)

name

public CacheBuilder<K,T> name(Object _containingObject,
                     String _fieldName)

Constructs a cache name out of the simple class name and fieldname. a cache name should be unique within an application / cache manager!

name

public CacheBuilder<K,T> name(String v)

keepDataAfterExpired

public CacheBuilder<K,T> keepDataAfterExpired(boolean v)

maxSize

public CacheBuilder<K,T> maxSize(int v)

maxSizeBound

public CacheBuilder<K,T> maxSizeBound(int v)

eternal

public CacheBuilder<K,T> eternal(boolean v)

Keep entries forever. Default is false. By default the cache uses an expiry time of 10 minutes.

suppressExceptions

public CacheBuilder<K,T> suppressExceptions(boolean v)

If an exceptions gets thrown by the cache source, suppress it if there is a previous value. When this is active, and an exception was suppressed the expiry is determined by the exception expiry settings. Default: true

heapEntryCapacity

public CacheBuilder<K,T> heapEntryCapacity(int v)

expiryDuration

public CacheBuilder<K,T> expiryDuration(long v,
                               TimeUnit u)

Set the time duration after an entry expires. To switch off time based expiry use eternal(boolean). A value of 0 effectively disables the cache.

If an EntryExpiryCalculator is set, this setting controls the maximum possible expiry duration.

exceptionExpiryDuration

public CacheBuilder<K,T> exceptionExpiryDuration(long v,
                                        TimeUnit u)

Separate timeout in the case an exception was thrown in the cache source. By default 10% of the normal expiry is used.

expirySecs

public CacheBuilder<K,T> expirySecs(int v)

Deprecated. since 0.20, please use expiryDuration(long, java.util.concurrent.TimeUnit)

expiryMillis

public CacheBuilder<K,T> expiryMillis(long v)

Deprecated. since 0.20, please use expiryDuration(long, java.util.concurrent.TimeUnit)

source

public CacheBuilder<K,T> source(CacheSource<K,T> g)

source

public CacheBuilder<K,T> source(CacheSourceWithMetaInfo<K,T> g)

source

public CacheBuilder<K,T> source(ExperimentalBulkCacheSource<K,T> g)

source

public CacheBuilder<K,T> source(BulkCacheSource<K,T> g)

entryExpiryCalculator

public CacheBuilder<K,T> entryExpiryCalculator(EntryExpiryCalculator c)

Set expiry calculator to use. If expiryDuration(long, java.util.concurrent.TimeUnit) is set to 0 then expiry calculation is not used, all entries expire immediately.

exceptionExpiryCalculator

public CacheBuilder<K,T> exceptionExpiryCalculator(ExceptionExpiryCalculator c)

Set expiry calculator to use in case of an exception happened in the CacheSource.

refreshController

public CacheBuilder<K,T> refreshController(RefreshController c)

Deprecated. since 0.20, please use entryExpiryCalculator

implementation

public CacheBuilder<K,T> implementation(Class<?> c)

getConfig

@Deprecated
public CacheConfig getConfig()

Deprecated.

build

public abstract Cache<K,T> build()

Builds a cache with the specified configuration parameters. The builder reused to build caches with similar or identical configuration. The builder is not thread safe.

Specified by:

build in interface AnyBuilder<K,T,CacheConfig>

Overrides:

build in class BaseAnyBuilder<K,T,CacheConfig>