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

java.lang.Object
- net.ymate.platform.cache.support.EhCacheWrapper

All Implemented Interfaces:

AutoCloseable, ICache, ICacheLocker, IDestroyable
```
public class EhCacheWrapper
extends Object
implements ICache, ICacheLocker
```
Author:

刘镇 (suninformation@163.com) on 15/12/7 上午12:16

Field Summary
- Fields inherited from interface net.ymate.platform.cache.ICache
  DEFAULT, MULTILEVEL, REDIS

Constructor Summary

Constructors
Constructor and Description

EhCacheWrapper(ICaches owner, Ehcache ehcache, ICacheEventListener listener)

Constructors
Constructor and Description
`EhCacheWrapper(ICaches owner, Ehcache ehcache, ICacheEventListener listener)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ICacheLocker`	`acquireCacheLocker()` 获取缓存锁对象，若缓存实例不支持则返回null
`void`	`clear()` 清理缓存
`void`	`close()`
`Object`	`get(Object key)` 从缓存中获取对象
`List<?>`	`keys()` 获取当前所有缓存对象key的集合
`void`	`put(Object key, Object value)` 添加对象到缓存
`void`	`put(Object key, Object value, int timeout)` 添加对象到缓存
`void`	`readLock(Object key)` 设置读锁
`void`	`releaseReadLock(Object key)` 释放读锁
`void`	`releaseWriteLock(Object key)` 释放写锁
`void`	`remove(Object key)` 从缓存中移除对象
`void`	`removeAll(Collection<?> keys)` 批量从缓存中移除对象
`boolean`	`tryReadLock(Object key, long timeout)` 尝试设置读锁，等待timeout毫秒时间
`boolean`	`tryWriteLock(Object key, long timeout)` 尝试设置写锁，等待timeout毫秒时间
`void`	`update(Object key, Object value)` 更新对象到缓存
`void`	`update(Object key, Object value, int timeout)` 更新对象到缓存
`void`	`writeLock(Object key)` 设置写锁

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

- Constructor Detail
  - EhCacheWrapper
```
public EhCacheWrapper(ICaches owner,
                      Ehcache ehcache,
                      ICacheEventListener listener)
```
- Method Detail
  - get
```
public Object get(Object key)
           throws CacheException
```
    Description copied from interface: ICache
    
    从缓存中获取对象
    
    Specified by:
    
    get in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    Returns:
    
    返回缓存的对象，若不存在则返回null
    
    Throws:
    
    CacheException - 可能产生的异常
  - put
```
public void put(Object key,
                Object value)
         throws CacheException
```
    Description copied from interface: ICache
    
    添加对象到缓存
    
    Specified by:
    
    put in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    value - 预缓存的元素对象
    
    Throws:
    
    CacheException - 可能产生的异常
  - put
```
public void put(Object key,
                Object value,
                int timeout)
         throws CacheException
```
    Description copied from interface: ICache
    
    添加对象到缓存
    
    Specified by:
    
    put in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    value - 预缓存的元素对象
    
    timeout - 自定义超时时间（秒），若为0则使用默认值
    
    Throws:
    
    CacheException - 可能产生的异常
  - update
```
public void update(Object key,
                   Object value)
            throws CacheException
```
    Description copied from interface: ICache
    
    更新对象到缓存
    
    Specified by:
    
    update in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    value - 预缓存的元素对象
    
    Throws:
    
    CacheException - 可能产生的异常
  - update
```
public void update(Object key,
                   Object value,
                   int timeout)
            throws CacheException
```
    Description copied from interface: ICache
    
    更新对象到缓存
    
    Specified by:
    
    update in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    value - 预缓存的元素对象
    
    timeout - 自定义超时时间（秒），若为0则使用默认值
    
    Throws:
    
    CacheException - 可能产生的异常
  - keys
```
public List<?> keys()
             throws CacheException
```
    Description copied from interface: ICache
    
    获取当前所有缓存对象key的集合
    
    Specified by:
    
    keys in interface ICache
    
    Returns:
    
    返回当前所有缓存对象key的集合
    
    Throws:
    
    CacheException - 可能产生的异常
  - remove
```
public void remove(Object key)
            throws CacheException
```
    Description copied from interface: ICache
    
    从缓存中移除对象
    
    Specified by:
    
    remove in interface ICache
    
    Parameters:
    
    key - 缓存key
    
    Throws:
    
    CacheException - 可能产生的异常
  - removeAll
```
public void removeAll(Collection<?> keys)
               throws CacheException
```
    Description copied from interface: ICache
    
    批量从缓存中移除对象
    
    Specified by:
    
    removeAll in interface ICache
    
    Parameters:
    
    keys - 缓存key集合
    
    Throws:
    
    CacheException - 可能产生的异常
  - clear
```
public void clear()
           throws CacheException
```
    Description copied from interface: ICache
    
    清理缓存
    
    Specified by:
    
    clear in interface ICache
    
    Throws:
    
    CacheException - 可能产生的异常
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - acquireCacheLocker
```
public ICacheLocker acquireCacheLocker()
```
    Description copied from interface: ICache
    
    获取缓存锁对象，若缓存实例不支持则返回null
    
    Specified by:
    
    acquireCacheLocker in interface ICache
    
    Returns:
    
    返回缓存锁对象
  - readLock
```
public void readLock(Object key)
```
    Description copied from interface: ICacheLocker
    
    设置读锁
    
    Specified by:
    
    readLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值
  - writeLock
```
public void writeLock(Object key)
```
    Description copied from interface: ICacheLocker
    
    设置写锁
    
    Specified by:
    
    writeLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值
  - tryReadLock
```
public boolean tryReadLock(Object key,
                           long timeout)
                    throws CacheException
```
    Description copied from interface: ICacheLocker
    
    尝试设置读锁，等待timeout毫秒时间
    
    Specified by:
    
    tryReadLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值
    
    timeout - 超时时间(毫秒)
    
    Returns:
    
    若锁定成功则返回true
    
    Throws:
    
    CacheException - 可能产生缓存异常
  - tryWriteLock
```
public boolean tryWriteLock(Object key,
                            long timeout)
                     throws CacheException
```
    Description copied from interface: ICacheLocker
    
    尝试设置写锁，等待timeout毫秒时间
    
    Specified by:
    
    tryWriteLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值
    
    timeout - 超时时间(毫秒)
    
    Returns:
    
    若锁定成功则返回true
    
    Throws:
    
    CacheException - 可能产生缓存异常
  - releaseReadLock
```
public void releaseReadLock(Object key)
```
    Description copied from interface: ICacheLocker
    
    释放读锁
    
    Specified by:
    
    releaseReadLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值
  - releaseWriteLock
```
public void releaseWriteLock(Object key)
```
    Description copied from interface: ICacheLocker
    
    释放写锁
    
    Specified by:
    
    releaseWriteLock in interface ICacheLocker
    
    Parameters:
    
    key - 缓存锁Key值

Class EhCacheWrapper

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EhCacheWrapper

Method Detail

get

put

put

update

update

keys

remove

removeAll

clear

close

acquireCacheLocker

readLock

writeLock

tryReadLock

tryWriteLock

releaseReadLock

releaseWriteLock