EhCache (J2Cache-码云(gitee.com))

java.lang.Object
- net.oschina.j2cache.ehcache.EhCache

All Implemented Interfaces:

Cloneable, Cache, Level1Cache, net.sf.ehcache.event.CacheEventListener
```
public class EhCache
extends Object
implements Level1Cache, net.sf.ehcache.event.CacheEventListener
```
EHCache 2.x 的缓存封装

该封装类实现了缓存操作以及对缓存数据失效的侦听

Author:

Winter Lau(javayou@gmail.com)

Constructor Summary

Constructors
Constructor and Description

EhCache(net.sf.ehcache.Cache cache, CacheExpiredListener listener)
Creates a new EhCache instance

Constructors
Constructor and Description
`EhCache(net.sf.ehcache.Cache cache, CacheExpiredListener listener)` Creates a new EhCache instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Remove all elements in the cache, but leave the cache in a useable state.
`Object`	`clone()`
`void`	`dispose()`
`void`	`evict(String... keys)` Removes the element which matches the key If no element matches, nothing is removed and no Exception is thrown.
`boolean`	`exists(String key)` 判断缓存是否存在
`Map<String,Object>`	`get(Collection<String> keys)` 批量获取缓存对象
`Serializable`	`get(String key)` Gets a value of an element which matches the given key.
`Collection<String>`	`keys()` Return all keys
`void`	`notifyElementEvicted(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element elem)`
`void`	`notifyElementExpired(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element elem)`
`void`	`notifyElementPut(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element elem)`
`void`	`notifyElementRemoved(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element elem)`
`void`	`notifyElementUpdated(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element elem)`
`void`	`notifyRemoveAll(net.sf.ehcache.Ehcache cache)`
`void`	`put(Map<String,Object> elements)` 批量插入数据
`void`	`put(String key, Object value)` Puts an object into the cache.
`long`	`size()` 返回该缓存区域中，内存存储对象的最大数量
`long`	`ttl()` 返回该缓存区域的 TTL 设置（单位：秒）

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

- Constructor Detail
  - EhCache
```
public EhCache(net.sf.ehcache.Cache cache,
               CacheExpiredListener listener)
```
    Creates a new EhCache instance
    
    Parameters:
    
    cache - The underlying EhCache instance to use.
    
    listener - cache listener
- Method Detail
  - ttl
```
public long ttl()
```
    Description copied from interface: Level1Cache
    
    返回该缓存区域的 TTL 设置（单位：秒）
    
    Specified by:
    
    ttl in interface Level1Cache
    
    Returns:
    
    true if cache support ttl setting
  - size
```
public long size()
```
    Description copied from interface: Level1Cache
    
    返回该缓存区域中，内存存储对象的最大数量
    
    Specified by:
    
    size in interface Level1Cache
    
    Returns:
    
    cache size in memory
  - keys
```
public Collection<String> keys()
```
    Description copied from interface: Cache
    
    Return all keys
    
    Specified by:
    
    keys in interface Cache
    
    Returns:
    
    返回键的集合
  - get
```
public Serializable get(String key)
```
    Gets a value of an element which matches the given key.
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    
    key - the key of the element to return.
    
    Returns:
    
    The value placed into the cache with an earlier put, or null if not found or expired
  - put
```
public void put(String key,
                Object value)
```
    Puts an object into the cache.
    
    Specified by:
    
    put in interface Cache
    
    Parameters:
    
    key - a key
    
    value - a value
  - evict
```
public void evict(String... keys)
```
    Removes the element which matches the key If no element matches, nothing is removed and no Exception is thrown.
    
    Specified by:
    
    evict in interface Cache
    
    Parameters:
    
    keys - the key of the element to remove
  - get
```
public Map<String,Object> get(Collection<String> keys)
```
    Description copied from interface: Cache
    
    批量获取缓存对象
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    
    keys - cache keys
    
    Returns:
    
    return key-value objects
  - exists
```
public boolean exists(String key)
```
    Description copied from interface: Cache
    
    判断缓存是否存在
    
    Specified by:
    
    exists in interface Cache
    
    Parameters:
    
    key - cache key
    
    Returns:
    
    true if key exists
  - put
```
public void put(Map<String,Object> elements)
```
    Description copied from interface: Cache
    
    批量插入数据
    
    Specified by:
    
    put in interface Cache
    
    Parameters:
    
    elements - objects to be put in cache
  - clear
```
public void clear()
```
    Remove all elements in the cache, but leave the cache in a useable state.
    
    Specified by:
    
    clear in interface Cache
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface net.sf.ehcache.event.CacheEventListener
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - notifyElementExpired
```
public void notifyElementExpired(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element elem)
```
    Specified by:
    
    notifyElementExpired in interface net.sf.ehcache.event.CacheEventListener
  - notifyElementEvicted
```
public void notifyElementEvicted(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element elem)
```
    Specified by:
    
    notifyElementEvicted in interface net.sf.ehcache.event.CacheEventListener
  - notifyElementPut
```
public void notifyElementPut(net.sf.ehcache.Ehcache cache,
                             net.sf.ehcache.Element elem)
```
    Specified by:
    
    notifyElementPut in interface net.sf.ehcache.event.CacheEventListener
  - notifyElementRemoved
```
public void notifyElementRemoved(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element elem)
```
    Specified by:
    
    notifyElementRemoved in interface net.sf.ehcache.event.CacheEventListener
  - notifyElementUpdated
```
public void notifyElementUpdated(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element elem)
```
    Specified by:
    
    notifyElementUpdated in interface net.sf.ehcache.event.CacheEventListener
  - notifyRemoveAll
```
public void notifyRemoveAll(net.sf.ehcache.Ehcache cache)
```
    Specified by:
    
    notifyRemoveAll in interface net.sf.ehcache.event.CacheEventListener
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface net.sf.ehcache.event.CacheEventListener

Class EhCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EhCache

Method Detail

ttl

size

keys

get

put

evict

get

exists

put

clear

clone

notifyElementExpired

notifyElementEvicted

notifyElementPut

notifyElementRemoved

notifyElementUpdated

notifyRemoveAll

dispose