CacheDefinition (vertigo-datastore 3.4.0 API)

java.lang.Object
- io.vertigo.core.node.definition.AbstractDefinition
- - io.vertigo.datastore.cache.definitions.CacheDefinition

All Implemented Interfaces:

io.vertigo.core.node.definition.Definition
```
public final class CacheDefinition
extends io.vertigo.core.node.definition.AbstractDefinition
```
The cache definition defines the configuration of a cache. This definition - has a name; - and 3 params that define the strategy of caching - max elements in memory - time to live - time to idle

Author:

pchretien

Field Summary

Fields
Modifier and Type Field Description

static String PREFIX
- Fields inherited from interface io.vertigo.core.node.definition.Definition
  REGEX_DEFINITION_NAME

Constructor Summary

Constructors
Constructor	Description
`CacheDefinition(String name, boolean serializeElements, int maxElementsInMemory, int timeToLiveSeconds, int timeToIdleSeconds, boolean isReloadedByList)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getMaxElementsInMemory()`
`int`	`getTimeToIdleSeconds()`
`int`	`getTimeToLiveSeconds()`
`boolean`	`isReloadedByList()`
`boolean`	`shouldSerializeElements()`

Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition
getLocalName, getName, toString

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

- Field Detail
  - PREFIX
```
public static final String PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CacheDefinition
```
public CacheDefinition(String name,
                       boolean serializeElements,
                       int maxElementsInMemory,
                       int timeToLiveSeconds,
                       int timeToIdleSeconds,
                       boolean isReloadedByList)
```
    Constructor.
    
    Parameters:
    
    name - the name of the cache
    
    serializeElements - If elements are serialized
    
    maxElementsInMemory - Max elements stored in memory
    
    timeToLiveSeconds - Time to live (in seconds)
    
    timeToIdleSeconds - Time to live when idle (in seconds)
- Method Detail
  - shouldSerializeElements
```
public boolean shouldSerializeElements()
```
    Returns:
    
    elements should be serialized
  - getMaxElementsInMemory
```
public int getMaxElementsInMemory()
```
    Returns:
    
    Max elements stored in memory
  - getTimeToLiveSeconds
```
public int getTimeToLiveSeconds()
```
    Returns:
    
    Time to live (in seconds)
  - getTimeToIdleSeconds
```
public int getTimeToIdleSeconds()
```
    Returns:
    
    Time tio idle (in seconds)
  - isReloadedByList
```
public boolean isReloadedByList()
```