ConcurrentLinkedHashMap (firefly-common 4.0.9 API)

java.lang.Object
- com.firefly.utils.collection.ConcurrentLinkedHashMap<K,V>

类型参数:

K - the type of keys maintained by this map

V - the type of mapped values

所有已实现的接口:

Map<K,V>
```
public class ConcurrentLinkedHashMap<K,V>
extends Object
implements Map<K,V>
```
The ConcurrentLinkedHashMap is the reentrant version of LinkedHashMap, which is the thread safe collection. It uses many partitions to mitigate parallel conflict. As same as the LinkedHashMap, you can choose LRU or FIFO arithmetic to eliminate entry of the map.

作者:

Pengtao Qiu

嵌套类概要

嵌套类
限定符和类型	类和说明
`static interface`	`ConcurrentLinkedHashMap.MapEventListener<K,V>` The callback interface, when the some events(get, put, remove, eliminate) occur, the map will call it.

从接口继承的嵌套类/接口 java.util.Map
Map.Entry<K,V>

构造器概要

构造器
构造器和说明
`ConcurrentLinkedHashMap(boolean accessOrder, int maxEntries, ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener)`
`ConcurrentLinkedHashMap(boolean accessOrder, int maxEntries, ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener, int concurrencyLevel)`
`ConcurrentLinkedHashMap(int initialCapacity, float loadFactor, boolean accessOrder, int maxEntries, ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener, int concurrencyLevel)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`clear()` clear all map's entries, but it dosen't trigger the remove callback method
`boolean`	`containsKey(Object key)` Returns `true`, if this map contains a mapping for the specified key.
`boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`V`	`get(Object key)` Returns a value which the specified key is mapped.
`int`	`getConcurrencyLevel()` Returns a value which represents the number of map's partition
`int`	`getSegmentMask()` Mask value for indexing into segments.
`int`	`getSegmentShift()` Shift value for indexing within segments.
`boolean`	`isEmpty()` Returns `true`, if the map doesn't contain any entry.
`Set<K>`	`keySet()` Gets the all key in this map.
`V`	`put(K key, V value)` Associates the specified value with the specified key in this map.
`void`	`putAll(Map<? extends K,? extends V> m)` Puts another map into this map.
`V`	`remove(Object key)` Remove a entry from this map.
`int`	`size()` Gets the entry's total number.
`String`	`toString()`
`Collection<V>`	`values()` Returns a `Collection` view of the values contained in this map.

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

从接口继承的方法 java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- 构造器详细资料
  - ConcurrentLinkedHashMap
```
public ConcurrentLinkedHashMap(boolean accessOrder,
                               int maxEntries,
                               ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener)
```
    参数:
    
    accessOrder - the ordering mode - true for access-order, false for insertion-order
    
    maxEntries - map's the biggest capacity, it isn't accurate, the actual limit of capacity depends on the entry's number of every segment. For example, if you set the max entries is 64, and the concurrency level is 16, and then every segment's max entries is 64/16 = 4.
    
    mapEventListener - the callback method of map's operations
  - ConcurrentLinkedHashMap
```
public ConcurrentLinkedHashMap(boolean accessOrder,
                               int maxEntries,
                               ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener,
                               int concurrencyLevel)
```
    参数:
    
    accessOrder - accessOrder the ordering mode - true for access-order, false for insertion-order
    
    maxEntries - map's the biggest capacity, it isn't accurate, the actual limit of capacity depends on the entry's number of every segment. For example, if you set the max entries is 64, and the concurrency level is 16, and then every segment's max entries is 64/16 = 4.
    
    mapEventListener - the callback method of map's operations
    
    concurrencyLevel - the number of segment, default is 16
  - ConcurrentLinkedHashMap
```
public ConcurrentLinkedHashMap(int initialCapacity,
                               float loadFactor,
                               boolean accessOrder,
                               int maxEntries,
                               ConcurrentLinkedHashMap.MapEventListener<K,V> mapEventListener,
                               int concurrencyLevel)
```
    参数:
    
    initialCapacity - map initial capacity in every segment
    
    loadFactor - the load factor decide the map increase to what degree have to expand, default value is 0.75f
    
    accessOrder - the ordering mode - true for access-order, false for insertion-order
    
    maxEntries - map's the biggest capacity, it isn't accurate, the actual limit of capacity depends on the entry's number of every segment. For example, if you set the max entries is 64, and the concurrency level is 16, and then every segment's max entries is 64/16 = 4.
    
    mapEventListener - the callback method of map's operations
    
    concurrencyLevel - the number of segment, default is 16
- 方法详细资料
  - size
```
public int size()
```
    Gets the entry's total number.
    
    指定者:
    
    size 在接口中 Map<K,V>
    
    返回:
    
    entry's number
  - isEmpty
```
public boolean isEmpty()
```
    Returns true, if the map doesn't contain any entry.
    
    指定者:
    
    isEmpty 在接口中 Map<K,V>
    
    返回:
    
    true if this map contains no key-value mappings.
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true, if this map contains a mapping for the specified key.
    
    指定者:
    
    containsKey 在接口中 Map<K,V>
    
    返回:
    
    true, if this map contains a mapping for the specified key.
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value.
    
    指定者:
    
    containsValue 在接口中 Map<K,V>
    
    返回:
    
    true if this map maps one or more keys to the specified value.
  - get
```
public V get(Object key)
```
    Returns a value which the specified key is mapped. At the same time, this method will call the callback interface, the getting entry event will be triggered.
    
    指定者:
    
    get 在接口中 Map<K,V>
    
    参数:
    
    key - the key whose associated value is to be returned
    
    返回:
    
    the value which the specified key is mapped, or null if this map contains no mapping for the key
  - put
```
public V put(K key,
             V value)
```
    Associates the specified value with the specified key in this map. If the key existed in the map, the entry will be replaced by specified entry. This method will call the putting entry event when the method is called.
    
    指定者:
    
    put 在接口中 Map<K,V>
    
    参数:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    返回:
    
    the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)
  - remove
```
public V remove(Object key)
```
    Remove a entry from this map. The removing event will be called.
    
    指定者:
    
    remove 在接口中 Map<K,V>
    
    参数:
    
    key - key whose mapping is to be removed from the map
    
    返回:
    
    the previous value associated with key, or null if there was no mapping for key.
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Puts another map into this map.
    
    指定者:
    
    putAll 在接口中 Map<K,V>
    
    参数:
    
    m - mappings to be stored in this map
  - clear
```
public void clear()
```
    clear all map's entries, but it dosen't trigger the remove callback method
    
    指定者:
    
    clear 在接口中 Map<K,V>
  - keySet
```
public Set<K> keySet()
```
    Gets the all key in this map.
    
    指定者:
    
    keySet 在接口中 Map<K,V>
    
    返回:
    
    a set view of the keys contained in this map
  - values
```
public Collection<V> values()
```
    Returns a Collection view of the values contained in this map.
    
    指定者:
    
    values 在接口中 Map<K,V>
    
    返回:
    
    a collection view of the values contained in this map
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns a Set view of the mappings contained in this map.
    
    指定者:
    
    entrySet 在接口中 Map<K,V>
    
    返回:
    
    a set view of the mappings contained in this map
  - getConcurrencyLevel
```
public int getConcurrencyLevel()
```
    Returns a value which represents the number of map's partition
    
    返回:
    
    a value which represents the partition's number.
  - getSegmentShift
```
public int getSegmentShift()
```
    Shift value for indexing within segments.
    
    返回:
    
    shift value for indexing within segments.
  - getSegmentMask
```
public int getSegmentMask()
```
    Mask value for indexing into segments. The upper bits of a key's hash code are used to choose the segment.
    
    返回:
    
    mask value for indexing into segments.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 ConcurrentLinkedHashMap<K,V>

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

构造器概要

方法概要

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

从接口继承的方法 java.util.Map

构造器详细资料

ConcurrentLinkedHashMap

ConcurrentLinkedHashMap

ConcurrentLinkedHashMap

方法详细资料

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

getConcurrencyLevel

getSegmentShift

getSegmentMask

toString