CacheConfig (Nerd4j Utils 2.0.0 API)

java.lang.Object
- org.nerd4j.utils.cache.CacheConfig

```
public class CacheConfig
extends Object
```
Immutable object collecting all the configurations needed by the SelfLoadingCache.

Since:

2.0.0

Author:

Massimo Coluzzi

Field Summary

Fields
Modifier and Type	Field and Description
`protected static long`	`DEFAULT_CACHE_DURATION` Default duration of a cache entry in milliseconds (60 minutes).
`protected static long`	`DEFAULT_TOUCH_DURATION` Default duration in milliseconds used by the method `CacheProvider.touch(CacheKey,long)` (10 minutes).
`protected static boolean`	`disabledAll` Tells if all the `SelfLoadingCache`s in the system are disabled.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CacheConfig()` Default constructor.
`protected`	`CacheConfig(long cacheDuration, long touchDuration, boolean asyncInsert, boolean asyncUpdate, boolean throwCacheProviderExceptions)` Constructor with parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`disableAll(boolean disable)` Invoking this method with `true` will disable all `SelfLoadingCache` instances in the system.
`boolean`	`equals(Object other)`
`long`	`getCacheDuration()` Returns the duration of a cache entry in milliseconds.
`static CacheConfig`	`getDefault()` Creates a new `CacheConfig` with the following default values: `getCacheDuration()` = `DEFAULT_CACHE_DURATION` `getTouchDuration()` = `DEFAULT_TOUCH_DURATION` `isAsyncInsert()` = `false` `isAsyncUpdate()` = `true` `isThrowCacheProviderExceptions()` = `false`
`long`	`getTouchDuration()` Returns the number of milliseconds to defer a cache entry expiration to, during update.
`int`	`hashCode()`
`boolean`	`isAsyncInsert()` Tells if the insert of a new entry in the cache should be done asynchronously.
`boolean`	`isAsyncUpdate()` Tells if the update of an existing entry in the cache should be done asynchronously.
`boolean`	`isThrowCacheProviderExceptions()` Tells if any exception generated by the `CacheProvider` should be propagated outside the `SelfLoadingCache`.
`static CacheConfig`	`of(boolean asyncInsert, boolean asyncUpdate, boolean throwCacheProviderExceptions)` Creates a new `CacheConfig` with the default cache and touch durations and given values.
`static CacheConfig`	`of(long cacheDuration, long touchDuration, boolean asyncInsert, boolean asyncUpdate, boolean throwCacheProviderExceptions)` Creates a new `CacheConfig` with the given values.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_CACHE_DURATION
```
protected static final long DEFAULT_CACHE_DURATION
```
    Default duration of a cache entry in milliseconds (60 minutes).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TOUCH_DURATION
```
protected static final long DEFAULT_TOUCH_DURATION
```
    Default duration in milliseconds used by the method CacheProvider.touch(CacheKey,long) (10 minutes).
    
    See Also:
    
    Constant Field Values
  - disabledAll
```
protected static boolean disabledAll
```
    Tells if all the SelfLoadingCaches in the system are disabled. If this flag is set to true all the caching will be skipped and all data will be loaded on each request.
    This option should be used to debugging purposes only, using this option in production can be very dangerous.
- Constructor Detail
  - CacheConfig
```
protected CacheConfig()
```
    Default constructor.
    This constructor is intended to be used by reflection during de-serialization.
    To create a new cache configuration use the factory methods.
  - CacheConfig
```
protected CacheConfig(long cacheDuration,
                      long touchDuration,
                      boolean asyncInsert,
                      boolean asyncUpdate,
                      boolean throwCacheProviderExceptions)
```
    Constructor with parameters.
    This constructor is intended to be used by extending classes only.
    To create a new cache configuration use the factory methods.
    
    Parameters:
    
    cacheDuration - duration of the cache entry after put.
    
    touchDuration - duration of the cache entry after touch.
    
    asyncInsert - tells if the insert should be done asynchronously.
    
    asyncUpdate - tells if the update should be done asynchronously.
    
    throwCacheProviderExceptions - tells if any exception generated by the CacheProvider should be thrown.
- Method Detail
  - getDefault
```
public static CacheConfig getDefault()
```
    Creates a new CacheConfig with the following default values:
    - getCacheDuration() = DEFAULT_CACHE_DURATION
    - getTouchDuration() = DEFAULT_TOUCH_DURATION
    - isAsyncInsert() = false
    - isAsyncUpdate() = true
    - isThrowCacheProviderExceptions() = false
    Returns:
    
    a new CacheConfig with default values.
  - of
```
public static CacheConfig of(boolean asyncInsert,
                             boolean asyncUpdate,
                             boolean throwCacheProviderExceptions)
```
    Creates a new CacheConfig with the default cache and touch durations and given values.
    
    Parameters:
    
    asyncInsert - tells if the insert should be done asynchronously.
    
    asyncUpdate - tells if the update should be done asynchronously.
    
    throwCacheProviderExceptions - tells if any exception generated by the CacheProvider should be thrown.
    
    Returns:
    
    a new CacheConfig with the given values.
  - of
```
public static CacheConfig of(long cacheDuration,
                             long touchDuration,
                             boolean asyncInsert,
                             boolean asyncUpdate,
                             boolean throwCacheProviderExceptions)
```
    Creates a new CacheConfig with the given values.
    
    Parameters:
    
    cacheDuration - duration of the cache entry after put.
    
    touchDuration - duration of the cache entry after touch.
    
    asyncInsert - tells if the insert should be done asynchronously.
    
    asyncUpdate - tells if the update should be done asynchronously.
    
    throwCacheProviderExceptions - tells if any exception generated by the CacheProvider should be thrown.
    
    Returns:
    
    a new CacheConfig with the given values.
  - disableAll
```
public static void disableAll(boolean disable)
```
    Invoking this method with true will disable all SelfLoadingCache instances in the system. All the caching will be skipped and all data will be loaded from the DataProvider on each request.
    This option should be used to debugging purposes only, using this option in production can be very dangerous.
    Invoking this method with false will restore the caching process.
    
    Parameters:
    
    disable - tells if all SelfLoadingCache instances need to stop all caching operations.
  - getCacheDuration
```
public long getCacheDuration()
```
    Returns the duration of a cache entry in milliseconds.
    
    Returns:
    
    the duration of a cache entry in milliseconds.
  - getTouchDuration
```
public long getTouchDuration()
```
    Returns the number of milliseconds to defer a cache entry expiration to, during update.
    
    Returns:
    
    the number of milliseconds to defer a cache entry expiration to, during update.
  - isAsyncInsert
```
public boolean isAsyncInsert()
```
    Tells if the insert of a new entry in the cache should be done asynchronously.
    
    Returns:
    
    true if the insert of a new entry in the cache should be done asynchronously.
  - isAsyncUpdate
```
public boolean isAsyncUpdate()
```
    Tells if the update of an existing entry in the cache should be done asynchronously.
    
    Returns:
    
    true if the insert of an existing entry in the cache should be done asynchronously.
  - isThrowCacheProviderExceptions
```
public boolean isThrowCacheProviderExceptions()
```
    Tells if any exception generated by the CacheProvider should be propagated outside the SelfLoadingCache. By default this values is false because an error in the caching system should not cause a crash in the application.
    
    Returns:
    
    true if any exception generated by the CacheProvider should be thrown.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CACHE_DURATION

DEFAULT_TOUCH_DURATION

disabledAll

Constructor Detail

CacheConfig

CacheConfig

Method Detail

getDefault

of

of

disableAll

getCacheDuration

getTouchDuration

isAsyncInsert

isAsyncUpdate

isThrowCacheProviderExceptions

hashCode

equals

toString