DefaultCacheConfig (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.cache.impl.DefaultCacheConfig

All Implemented Interfaces:

ICacheConfig, IInitialization<ICaches>
```
public final class DefaultCacheConfig
extends Object
implements ICacheConfig
```
缓存模块配置类

Author:

刘镇 (suninformation@163.com) on 14/12/25 下午5:58

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultCacheConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultCacheConfig.Builder`

Field Summary
- Fields inherited from interface net.ymate.platform.cache.ICacheConfig
  CONFIG_FILE, DEFAULT_CACHE_NAME, DEFAULT_CACHE_TIMEOUT, DEFAULT_CONFIG_FILE, DEFAULT_STR, ENABLED_SUBSCRIBE_EXPIRED, EVENT_LISTENER_CLASS, KEY_GENERATOR_CLASS, MULTILEVEL_SLAVE_AUTO_SYNC, PROVIDER_CLASS, SCOPE_PROCESSOR_CLASS, SERIALIZER_CLASS, STORAGE_WITH_SET

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DefaultCacheConfig.Builder`	`builder()`
`static DefaultCacheConfig`	`create(Class<?> mainClass, IModuleConfigurer moduleConfigurer)`
`static DefaultCacheConfig`	`create(IModuleConfigurer moduleConfigurer)`
`static DefaultCacheConfig`	`defaultConfig()`
`ICacheEventListener`	`getCacheEventListener()` 缓存对象事件监听器，可选参数，默认值为空
`ICacheProvider`	`getCacheProvider()` 缓存提供者，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheProvider
`ICacheScopeProcessor`	`getCacheScopeProcessor()` 缓存作用域处理器，可选参数，默认值为空
`File`	`getConfigFile()` 获取Ehcache配置文件，可选参数，若未设置或设置的文件路径无效将被忽略，默认值为空
`String`	`getDefaultCacheName()` 默认缓存名称，可选参数，默认值为default，对应于Ehcache配置文件中设置name="__DEFAULT__"
`int`	`getDefaultCacheTimeout()` 默认缓存数据超时时间(秒)，可选参数，数值必须大于等于0，默认值为0
`ICacheKeyGenerator<?>`	`getKeyGenerator()` 缓存Key生成器，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheKeyGenerator
`ISerializer`	`getSerializer()` 对象序列化接口实现，可选参数，默认值为 SerializerManager.getDefaultSerializer()
`void`	`initialize(ICaches owner)` 初始化
`boolean`	`isEnabledSubscribeExpired()` 是否开启Redis订阅缓存元素过期事件，可选参数，默认值为false
`boolean`	`isInitialized()` 是否已初始化
`boolean`	`isMultilevelSlavesAutoSync()` Multilevel模式下是否自动同步Master和Slave级缓存，可选参数，默认值为false
`boolean`	`isStorageWithSet()` 是否采用Set存储缓存键名
`void`	`setCacheEventListener(ICacheEventListener cacheEventListener)`
`void`	`setCacheProvider(ICacheProvider cacheProvider)`
`void`	`setCacheScopeProcessor(ICacheScopeProcessor cacheScopeProcessor)`
`void`	`setConfigFile(File configFile)`
`void`	`setDefaultCacheName(String defaultCacheName)`
`void`	`setDefaultCacheTimeout(int defaultCacheTimeout)`
`void`	`setEnabledSubscribeExpired(boolean enabledSubscribeExpired)`
`void`	`setKeyGenerator(ICacheKeyGenerator<?> keyGenerator)`
`void`	`setMultilevelSlavesAutoSync(boolean multilevelSlavesAutoSync)`
`void`	`setSerializer(ISerializer serializer)`
`void`	`setStorageWithSet(boolean storageWithSet)`

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

- Method Detail
  - defaultConfig
```
public static DefaultCacheConfig defaultConfig()
```
  - create
```
public static DefaultCacheConfig create(IModuleConfigurer moduleConfigurer)
```
  - create
```
public static DefaultCacheConfig create(Class<?> mainClass,
                                        IModuleConfigurer moduleConfigurer)
```
  - builder
```
public static DefaultCacheConfig.Builder builder()
```
  - initialize
```
public void initialize(ICaches owner)
                throws Exception
```
    Description copied from interface: IInitialization
    
    初始化
    
    Specified by:
    
    initialize in interface IInitialization<ICaches>
    
    Parameters:
    
    owner - 指定所属容器参数对象
    
    Throws:
    
    Exception - 初始过程中产生的任何异常
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: IInitialization
    
    是否已初始化
    
    Specified by:
    
    isInitialized in interface IInitialization<ICaches>
    
    Returns:
    
    返回true表示已初始化
  - getCacheProvider
```
public ICacheProvider getCacheProvider()
```
    Description copied from interface: ICacheConfig
    
    缓存提供者，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheProvider
    
    Specified by:
    
    getCacheProvider in interface ICacheConfig
    
    Returns:
    
    返回缓存提供者实例
  - setCacheProvider
```
public void setCacheProvider(ICacheProvider cacheProvider)
```
  - getCacheEventListener
```
public ICacheEventListener getCacheEventListener()
```
    Description copied from interface: ICacheConfig
    
    缓存对象事件监听器，可选参数，默认值为空
    
    Specified by:
    
    getCacheEventListener in interface ICacheConfig
    
    Returns:
    
    返回缓存对象事件监听器实例
  - setCacheEventListener
```
public void setCacheEventListener(ICacheEventListener cacheEventListener)
```
  - getCacheScopeProcessor
```
public ICacheScopeProcessor getCacheScopeProcessor()
```
    Description copied from interface: ICacheConfig
    
    缓存作用域处理器，可选参数，默认值为空
    
    Specified by:
    
    getCacheScopeProcessor in interface ICacheConfig
    
    Returns:
    
    返回缓存作用域处理器实例
  - setCacheScopeProcessor
```
public void setCacheScopeProcessor(ICacheScopeProcessor cacheScopeProcessor)
```
  - getKeyGenerator
```
public ICacheKeyGenerator<?> getKeyGenerator()
```
    Description copied from interface: ICacheConfig
    
    缓存Key生成器，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheKeyGenerator
    
    Specified by:
    
    getKeyGenerator in interface ICacheConfig
    
    Returns:
    
    返回缓存Key生成器实例
  - setKeyGenerator
```
public void setKeyGenerator(ICacheKeyGenerator<?> keyGenerator)
```
  - getSerializer
```
public ISerializer getSerializer()
```
    Description copied from interface: ICacheConfig
    
    对象序列化接口实现，可选参数，默认值为 SerializerManager.getDefaultSerializer()
    
    Specified by:
    
    getSerializer in interface ICacheConfig
    
    Returns:
    
    返回对象序列化接口实现
  - setSerializer
```
public void setSerializer(ISerializer serializer)
```
  - getDefaultCacheName
```
public String getDefaultCacheName()
```
    Description copied from interface: ICacheConfig
    
    默认缓存名称，可选参数，默认值为default，对应于Ehcache配置文件中设置name="__DEFAULT__"
    
    Specified by:
    
    getDefaultCacheName in interface ICacheConfig
    
    Returns:
    
    返回默认缓存名称
  - setDefaultCacheName
```
public void setDefaultCacheName(String defaultCacheName)
```
  - getDefaultCacheTimeout
```
public int getDefaultCacheTimeout()
```
    Description copied from interface: ICacheConfig
    
    默认缓存数据超时时间(秒)，可选参数，数值必须大于等于0，默认值为0
    
    Specified by:
    
    getDefaultCacheTimeout in interface ICacheConfig
    
    Returns:
    
    返回默认缓存数据超时时间(秒)
  - getConfigFile
```
public File getConfigFile()
```
    Description copied from interface: ICacheConfig
    
    获取Ehcache配置文件，可选参数，若未设置或设置的文件路径无效将被忽略，默认值为空
    
    Specified by:
    
    getConfigFile in interface ICacheConfig
    
    Returns:
    
    返回Ehcache配置文件
  - setConfigFile
```
public void setConfigFile(File configFile)
```
  - setDefaultCacheTimeout
```
public void setDefaultCacheTimeout(int defaultCacheTimeout)
```
  - isStorageWithSet
```
public boolean isStorageWithSet()
```
    Description copied from interface: ICacheConfig
    
    是否采用Set存储缓存键名
    
    Specified by:
    
    isStorageWithSet in interface ICacheConfig
    
    Returns:
    
    返回true表示采用
  - setStorageWithSet
```
public void setStorageWithSet(boolean storageWithSet)
```
  - isEnabledSubscribeExpired
```
public boolean isEnabledSubscribeExpired()
```
    Description copied from interface: ICacheConfig
    
    是否开启Redis订阅缓存元素过期事件，可选参数，默认值为false
    
    Specified by:
    
    isEnabledSubscribeExpired in interface ICacheConfig
    
    Returns:
    
    返回true表示已开启
  - setEnabledSubscribeExpired
```
public void setEnabledSubscribeExpired(boolean enabledSubscribeExpired)
```
  - isMultilevelSlavesAutoSync
```
public boolean isMultilevelSlavesAutoSync()
```
    Description copied from interface: ICacheConfig
    
    Multilevel模式下是否自动同步Master和Slave级缓存，可选参数，默认值为false
    
    Specified by:
    
    isMultilevelSlavesAutoSync in interface ICacheConfig
    
    Returns:
    
    返回true表示同步
  - setMultilevelSlavesAutoSync
```
public void setMultilevelSlavesAutoSync(boolean multilevelSlavesAutoSync)
```

Class DefaultCacheConfig

Nested Class Summary

Field Summary

Fields inherited from interface net.ymate.platform.cache.ICacheConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaultConfig

create

create

builder

initialize

isInitialized

getCacheProvider

setCacheProvider

getCacheEventListener

setCacheEventListener

getCacheScopeProcessor

setCacheScopeProcessor

getKeyGenerator

setKeyGenerator

getSerializer

setSerializer

getDefaultCacheName

setDefaultCacheName

getDefaultCacheTimeout

getConfigFile

setConfigFile

setDefaultCacheTimeout

isStorageWithSet

setStorageWithSet

isEnabledSubscribeExpired

setEnabledSubscribeExpired

isMultilevelSlavesAutoSync

setMultilevelSlavesAutoSync