org.nerd4j.utils.cache

Class SelfLoadingCacheBuilder<V>

java.lang.Object

org.nerd4j.utils.cache.SelfLoadingCacheBuilder<V>

Type Parameters:

V - type of the data to store in the cache.

public class SelfLoadingCacheBuilder<V>
extends Object

Implementation of the pattern Builder to build default instances of the SelfLoadingCache interface.

Since:

2.0.0

Author:

Massimo Coluzzi

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheProvider<V>	cacheProvider The underlying caching system provider.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SelfLoadingCacheBuilder(CacheProvider<V> cacheProvider) Default constructor.

Method Summary

Modifier and Type	Method and Description
SelfLoadingCache<V>	build() Creates a new default implementation of the SelfLoadingCache interface.
void	setAsyncInsert(boolean asyncInsert) Sets the given flag to tell if the cache should insert new keys asynchronously.
void	setAsyncUpdate(boolean asyncUpdate) Sets the given flag to tell if the cache should update existing keys asynchronously.
void	setCacheDuration(long cacheDuration) Sets the given value for the cache duration.
void	setThrowCacheProviderExceptions(boolean throwCacheProviderExceptions) Sets the given flag to tell if the cache should propagate cache related exceptions.
void	setTouchDuration(long touchDuration) Sets the given value for the touch duration.
SelfLoadingCacheBuilder	withAsyncInsert(boolean asyncInsert) Sets the given flag to tell if the cache should insert new keys asynchronously and returns this builder instance.
SelfLoadingCacheBuilder	withAsyncUpdate(boolean asyncUpdate) Sets the given flag to tell if the cache should update existing keys asynchronously and returns this builder instance.
SelfLoadingCacheBuilder	withCacheDuration(long cacheDuration) Sets the given value for the cache duration and returns this builder instance.
SelfLoadingCacheBuilder	withThrowCacheProviderExceptions(boolean throwCacheProviderExceptions) Sets the given flag to tell if the cache should propagate cache related exceptions and returns this builder instance.
SelfLoadingCacheBuilder	withTouchDuration(long touchDuration) Sets the given value for the touch duration and returns this builder instance.

Methods inherited from class java.lang.Object

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

Field Detail

cacheProvider

protected final CacheProvider<V> cacheProvider

The underlying caching system provider.

Constructor Detail

SelfLoadingCacheBuilder

protected SelfLoadingCacheBuilder(CacheProvider<V> cacheProvider)

Default constructor.

This constructor is intended to be used by reflection during de-serialization.

To create a new cache configuration use the factory methods.

Parameters:

cacheProvider - the CacheProvider to be injected into the SelfLoadingCache created by this builder.

Throws:

RequirementFailure - if the provided CacheProvider is null.

Method Detail

setCacheDuration

public void setCacheDuration(long cacheDuration)

Sets the given value for the cache duration.

By default this values is set to 1 hour (3600000 ms).

Parameters:

cacheDuration - the cache duration to set.

Throws:

RequirementFailure - if the duration value is less or equal to zero.

withCacheDuration

public SelfLoadingCacheBuilder withCacheDuration(long cacheDuration)

Sets the given value for the cache duration and returns this builder instance.

By default this values is set to 1 hour (3600000 ms).

Parameters:

cacheDuration - the cache duration to set.

Returns:

this builder instance.

Throws:

RequirementFailure - if the duration value is less or equal to zero.

setTouchDuration

public void setTouchDuration(long touchDuration)

Sets the given value for the touch duration.

By default this values is set to 10 minutes (600000 ms).

Parameters:

touchDuration - the touch duration to set.

Throws:

RequirementFailure - if the duration value is less or equal to zero.

withTouchDuration

public SelfLoadingCacheBuilder withTouchDuration(long touchDuration)

Sets the given value for the touch duration and returns this builder instance.

By default this values is set to 10 minutes (600000 ms).

Parameters:

touchDuration - the touch duration to set.

Returns:

this builder instance.

Throws:

RequirementFailure - if the duration value is less or equal to zero.

setAsyncInsert

public void setAsyncInsert(boolean asyncInsert)

Sets the given flag to tell if the cache should insert new keys asynchronously.

By default this value is false forcing the requesting thread to load and return the expected data.

Parameters:

asyncInsert - asynchronous insert flag.

withAsyncInsert

public SelfLoadingCacheBuilder withAsyncInsert(boolean asyncInsert)

Sets the given flag to tell if the cache should insert new keys asynchronously and returns this builder instance.

By default this value is false forcing the requesting thread to load and return the expected data.

Parameters:

asyncInsert - asynchronous insert flag.

Returns:

this builder instance.

setAsyncUpdate

public void setAsyncUpdate(boolean asyncUpdate)

Sets the given flag to tell if the cache should update existing keys asynchronously.

By default this value is true allowing the current thread to return immediately the cached value.

Parameters:

asyncUpdate - asynchronous update flag.

withAsyncUpdate

public SelfLoadingCacheBuilder withAsyncUpdate(boolean asyncUpdate)

Sets the given flag to tell if the cache should update existing keys asynchronously and returns this builder instance.

By default this value is true allowing the current thread to return immediately the cached value.

Parameters:

asyncUpdate - asynchronous update flag.

Returns:

this builder instance.

setThrowCacheProviderExceptions

public void setThrowCacheProviderExceptions(boolean throwCacheProviderExceptions)

Sets the given flag to tell if the cache should propagate cache related exceptions.

By default this values is false because an error in the caching system should not cause a crash in the application.

Parameters:

throwCacheProviderExceptions - cache related propagation flag.

withThrowCacheProviderExceptions

public SelfLoadingCacheBuilder withThrowCacheProviderExceptions(boolean throwCacheProviderExceptions)

Sets the given flag to tell if the cache should propagate cache related exceptions and returns this builder instance.

By default this values is false because an error in the caching system should not cause a crash in the application.

Parameters:

throwCacheProviderExceptions - cache related propagation flag.

Returns:

this builder instance.

build

public SelfLoadingCache<V> build()

Creates a new default implementation of the SelfLoadingCache interface.

Returns:

new default SelfLoadingCache.