CacheConfiguration (XWiki Commons - Cache - API 14.10.7 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,Object>
  - - org.xwiki.cache.config.CacheConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

Direct Known Subclasses:

LRUCacheConfiguration
```
public class CacheConfiguration
extends HashMap<String,Object>
```
Contains all informations used to create the cache.
A configuration identifier can be defined.
It can be used to be the cache unique identifier for clustering process.
This is also used by implementations to associate the cache with a configuration file which overwrite the configuration it contains. This way any cache can be tuned in a particular installation with option specifics to chosen cache implementation.

Version:

$Id: 15a2f06d4864cc3bd18c207da40ee904c43c3804 $

See Also:

EntryEvictionConfiguration, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors
Constructor	Description
`CacheConfiguration()`	The default constructor.
`CacheConfiguration(String configurationId)`
`CacheConfiguration(String configurationId, EntryEvictionConfiguration evictionConfiguration)`	Creates CacheConfiguration instance with given eviction configuration and id.
`CacheConfiguration(EntryEvictionConfiguration evictionConfiguration)`	Creates CacheConfiguration instance with given eviction configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getConfigurationId()

void setConfigurationId(String configurationId)
- Methods inherited from class java.util.HashMap
  clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
- Methods inherited from class java.util.AbstractMap
  equals, hashCode, toString
- Methods inherited from class java.lang.Object
  finalize, getClass, notify, notifyAll, wait, wait, wait
- Methods inherited from interface java.util.Map
  equals, hashCode

- Constructor Detail
  - CacheConfiguration
```
public CacheConfiguration()
```
    The default constructor.
  - CacheConfiguration
```
public CacheConfiguration(String configurationId)
```
    Parameters:
    
    configurationId - the configuration identifier
    
    Since:
    
    4.3M1
  - CacheConfiguration
```
public CacheConfiguration(EntryEvictionConfiguration evictionConfiguration)
```
    Creates CacheConfiguration instance with given eviction configuration.
    
    Parameters:
    
    evictionConfiguration - describes details of entry eviction method.
    
    Since:
    
    4.3M1
  - CacheConfiguration
```
public CacheConfiguration(String configurationId,
                          EntryEvictionConfiguration evictionConfiguration)
```
    Creates CacheConfiguration instance with given eviction configuration and id.
    
    Parameters:
    
    evictionConfiguration - describes details of entry eviction method.
    
    configurationId - the configuration identifier.
    
    Since:
    
    4.3M1
- Method Detail
  - setConfigurationId
```
public void setConfigurationId(String configurationId)
```
    Parameters:
    
    configurationId - the configuration identifier.
  - getConfigurationId
```
public String getConfigurationId()
```
    Returns:
    
    the configuration identifier.