CacheMapProxy (ctp-core 7.0SP2-SNAPSHOT API)

java.lang.Object
- com.seeyon.ctp.common.cache.redis.CacheMapProxy<K,V>

所有已实现的接口:: CacheMap<K,V>, GroupCacheable

public class CacheMapProxy<K extends Serializable,V extends Serializable>
extends Object
implements CacheMap<K,V>

构造器概要

构造器
构造器和说明

CacheMapProxy(CacheMap originMap)

构造器
构造器和说明
`CacheMapProxy(CacheMap originMap)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clear()` 清除所有缓存项。
`boolean`	`contains(K key)` 判断是否存在指定的缓存项。
`V`	`get(K key)` 取得指定的缓存项。
`DataLoader<K>`	`getDataLoader()` 取得缓存数据加载。
`String`	`getGroup()` 取得缓存所属的组。
`String`	`getName()` 取得缓存名称。
`CacheStatistics`	`getStatistics()` 获取缓存统计对象。
`void`	`index(MapIndex<V> idx)` 为缓存增加索引，索引后可以通过values(String indexName,Object o)快速筛选满足条件的值集合。
`boolean`	`isEmpty()` Returns `true` if this list contains no elements.
`Set<K>`	`keySet()` Returns a set view of the keys contained in this map.
`void`	`notifyUpdate(Collection<K> keys)` 批量通知缓存项改变，需要更新。
`void`	`notifyUpdate(K key)` 通知缓存项改变，需要更新。
`void`	`notifyUpdate(K[] keys)` 批量通知缓存项改变，需要更新。
`void`	`notifyUpdate(K key, Serializable updateKey, CacheNotification.Action operation, Serializable content)`
`void`	`put(K key, V value)` 设置缓存。
`void`	`putAll(Map<? extends K,? extends V> map)` 将Map中的所有项目设置到缓存中。
`void`	`reload()` 通过dataloader重新加载整个缓存，如果没有dataloader，不做任何操作。
`void`	`reload(K k)` 通过dataloader加载指定缓存项，如果没有dataloader，不做任何操作。
`V`	`remove(K key)` 移除缓存项。
`boolean`	`removeAll(Collection<K> keys)` 移除缓存项。
`void`	`replaceAll(Map<? extends K,? extends V> map)` 清除缓存并将Map中的所有项目设置到缓存中。
`void`	`setDataLoader(DataLoader<K> loader)` 设置缓存数据加载。
`int`	`size()` Returns the number of elements in this list.
`Map<K,V>`	`toMap()` 将缓存转化为Map表示。
`Collection<V>`	`values()` Returns a collection view of the values contained in this map.
`Collection<V>`	`values(String indexName, Object o)` 按照索引过滤缓存的值。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CacheMapProxy
```
public CacheMapProxy(CacheMap originMap)
```
- 方法详细资料
  - put
```
public void put(K key,
                V value)
```
    从接口复制的说明: CacheMap
    
    设置缓存。如果指定的缓存项已存在则以新值覆盖。
    
    指定者:
    
    put 在接口中 CacheMap<K extends Serializable,V extends Serializable>
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    从接口复制的说明: CacheMap
    
    将Map中的所有项目设置到缓存中。效果相当于循环调用put，但性能要高一些。不清除原有项目进行追加，如果Key冲突则覆盖原缓存项。
    
    指定者:
    
    putAll 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    map - Java Map
  - replaceAll
```
public void replaceAll(Map<? extends K,? extends V> map)
```
    从接口复制的说明: CacheMap
    
    清除缓存并将Map中的所有项目设置到缓存中。效果相当于先clear再putAll。
    
    指定者:
    
    replaceAll 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    map - Java Map
  - notifyUpdate
```
public void notifyUpdate(K key)
```
    从接口复制的说明: CacheMap
    
    通知缓存项改变，需要更新。
    
    指定者:
    
    notifyUpdate 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    key - 缓存的Key
  - notifyUpdate
```
public void notifyUpdate(K[] keys)
```
    从接口复制的说明: CacheMap
    
    批量通知缓存项改变，需要更新。
    
    指定者:
    
    notifyUpdate 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    keys - 缓存的Key数组
  - notifyUpdate
```
public void notifyUpdate(Collection<K> keys)
```
    从接口复制的说明: CacheMap
    
    批量通知缓存项改变，需要更新。
    
    指定者:
    
    notifyUpdate 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    keys - 缓存的Key集合
  - notifyUpdate
```
public void notifyUpdate(K key,
                         Serializable updateKey,
                         CacheNotification.Action operation,
                         Serializable content)
```
    指定者:
    
    notifyUpdate 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    key - cacheMap中存放的key
    
    updateKey - cacheMap.get(key)获取的对象为Map，该Map中存储的key
    
    operation - 具体的操作类型，参考：CacheNotification.Action
    
    content - 更新的mapKey对应的内容对象，当operation为Remove|Clear时，content参数无意义
  - get
```
public V get(K key)
```
    从接口复制的说明: CacheMap
    
    取得指定的缓存项。
    
    指定者:
    
    get 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    key - 缓存的Key
    
    返回:
    
    如果不存在返回null，缓存值为null 时会有歧义，如果需要判断请使用contains方法。
  - remove
```
public V remove(K key)
```
    从接口复制的说明: CacheMap
    
    移除缓存项。
    
    指定者:
    
    remove 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    key - 缓存的Key
    
    返回:
    
    被移除的缓存项。如果不存在返回null。
  - removeAll
```
public boolean removeAll(Collection<K> keys)
```
    从接口复制的说明: CacheMap
    
    移除缓存项。
    
    指定者:
    
    removeAll 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    返回:
    
    如果有元素被移除返回true，否则返回false。
  - contains
```
public boolean contains(K key)
```
    从接口复制的说明: CacheMap
    
    判断是否存在指定的缓存项。
    
    指定者:
    
    contains 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    key - 缓存的Key
    
    返回:
    
    存在返回true，否则返回false。
  - toMap
```
public Map<K,V> toMap()
```
    从接口复制的说明: CacheMap
    
    将缓存转化为Map表示。
    
    指定者:
    
    toMap 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    返回:
    
    Map，Key为缓存的Key，Value为缓存中的对象。
  - keySet
```
public Set<K> keySet()
```
    从接口复制的说明: CacheMap
    
    Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll retainAll, and clear operations. It does not support the add or addAll operations.
    
    指定者:
    
    keySet 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    返回:
    
    a set view of the keys contained in this map.
  - values
```
public Collection<V> values()
```
    从接口复制的说明: CacheMap
    
    Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    
    指定者:
    
    values 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    返回:
    
    a collection view of the values contained in this map.
  - setDataLoader
```
public void setDataLoader(DataLoader<K> loader)
```
    从接口复制的说明: CacheMap
    
    设置缓存数据加载。
    
    指定者:
    
    setDataLoader 在接口中 CacheMap<K extends Serializable,V extends Serializable>
  - getDataLoader
```
public DataLoader<K> getDataLoader()
```
    从接口复制的说明: CacheMap
    
    取得缓存数据加载。
    
    指定者:
    
    getDataLoader 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    返回:
  - reload
```
public void reload()
```
    从接口复制的说明: CacheMap
    
    通过dataloader重新加载整个缓存，如果没有dataloader，不做任何操作。
    
    指定者:
    
    reload 在接口中 CacheMap<K extends Serializable,V extends Serializable>
  - reload
```
public void reload(K k)
```
    从接口复制的说明: CacheMap
    
    通过dataloader加载指定缓存项，如果没有dataloader，不做任何操作。
    
    指定者:
    
    reload 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    k - 缓存的key
  - index
```
public void index(MapIndex<V> idx)
```
    从接口复制的说明: CacheMap
    为缓存增加索引，索引后可以通过values(String indexName,Object o)快速筛选满足条件的值集合。
    请在缓存创建后立刻调用，否则之前增加的项目不会被索引。
```
                 
    cache.index(new MapIndex("category"){
                Object getValue(CtpConfig v) {
                        return v.getCategory();
                }
        });
 
```
    指定者:
    
    index 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    idx - 缓存索引对象。
  - values
```
public Collection<V> values(String indexName,
                            Object o)
```
    从接口复制的说明: CacheMap
    
    按照索引过滤缓存的值。
    
    指定者:
    
    values 在接口中 CacheMap<K extends Serializable,V extends Serializable>
    
    参数:
    
    indexName - 索引名称。
    
    o - 索引值
    
    返回:
    
    满足索引值条件的集合。
  - getGroup
```
public String getGroup()
```
    从接口复制的说明: GroupCacheable
    
    取得缓存所属的组。
    
    指定者:
    
    getGroup 在接口中 GroupCacheable
    
    返回:
    
    缓存所属组。
  - getName
```
public String getName()
```
    从接口复制的说明: GroupCacheable
    
    取得缓存名称。
    
    指定者:
    
    getName 在接口中 GroupCacheable
    
    返回:
    
    缓存名称。
  - size
```
public int size()
```
    从接口复制的说明: GroupCacheable
    
    Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    指定者:
    
    size 在接口中 GroupCacheable
    
    返回:
    
    the number of elements in this list.
  - isEmpty
```
public boolean isEmpty()
```
    从接口复制的说明: GroupCacheable
    
    Returns true if this list contains no elements.
    
    指定者:
    
    isEmpty 在接口中 GroupCacheable
    
    返回:
    
    true if this list contains no elements.
  - clear
```
public void clear()
```
    从接口复制的说明: GroupCacheable
    
    清除所有缓存项。
    
    指定者:
    
    clear 在接口中 GroupCacheable
  - getStatistics
```
public CacheStatistics getStatistics()
```
    从接口复制的说明: GroupCacheable
    
    获取缓存统计对象。
    
    指定者:
    
    getStatistics 在接口中 GroupCacheable
    
    返回:
    
    缓存统计对象，记录缓存的访问信息。

类 CacheMapProxy<K extends Serializable,V extends Serializable>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CacheMapProxy

方法详细资料

put

putAll

replaceAll

notifyUpdate

notifyUpdate

notifyUpdate

notifyUpdate

get

remove

removeAll

contains

toMap

keySet

values

setDataLoader

getDataLoader

reload

reload

index

values

getGroup

getName

size

isEmpty

clear

getStatistics