DefaultHashMap (blade-kit 1.0.3 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - blade.collection.DefaultHashMap<K,V>

类型参数:

K -

V -

所有已实现的接口:

Serializable, Cloneable, Map<K,V>

直接已知子类:

ArrayHashMap
```
public class DefaultHashMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable
```
Hash表的一个实现, 实现了Map接口.
这个hash表的实现完全类似JDK的HashMap, 但作了如下改变, 以便于子类派生, 并实现特殊功能:
- 将部分类成员设置成protected和friendly
- 增加了一些方法和事件
和JDK的HashMap一样, 这个实现具有以下特性:
- 支持值为null的key和value
- 没有进行任何synchronized操作, 因而不是线程安全的. 但可以通过以下操作实现线程安全:
```
 Map m = Collections.synchronizedMap(new DefaultHashMap(...));
 
```
- 不保证hash表中的entry的顺序
- 以几乎衡定的性能存取hash表中的每个entry
- 从hash表中取得的任何Iterator具有fail-fast特性: 当hash表的结构被改变时, 调用 Iterator.remove和 Iterator.add方法时, 会掷出 ConcurrentModificationException. 这样确保不会出现不确定的情况.
从以下版本开始:

1.0

作者:

biezhi

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class DefaultHashMap.Entry<K,V>
Map.Entry的实现.
- 从类继承的嵌套类/接口 java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

嵌套类
限定符和类型	类和说明
`protected static class`	`DefaultHashMap.Entry<K,V>` Map.Entry的实现.

字段概要

字段
限定符和类型	字段和说明
`protected float`	`loadFactor` 负载系数.
`protected int`	`modCount` 当hash表发生"结构改变"的计数.
`protected int`	`size` Hash表中的entry数.
`protected DefaultHashMap.Entry<K,V>[]`	`table` Hash表, 长度可变 - 但长度必须是2的整数次幂.
`protected int`	`threshold` 阈值.

构造器概要

构造器
构造器和说明
`DefaultHashMap()` 创建一个空的hash表.
`DefaultHashMap(int initialCapacity)` 创建一个空的hash表.
`DefaultHashMap(int initialCapacity, float loadFactor)` 创建一个空的hash表.
`DefaultHashMap(Map<? extends K,? extends V> map)` 复制指定Map内容相同的HashMap.

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`protected void`	`addEntry(K key, V value)` 加入一个entry到hash表中, 但不会对hash表进行resize()操作.
`void`	`clear()` 清除hash表中的所有entry.
`Object`	`clone()` "浅"拷贝hash表, key和value本身并不被复制.
`boolean`	`containsKey(Object key)` 如果hash表中包含指定key的entry, 则返回true.
`boolean`	`containsValue(Object value)` 判断hash表中是否有一个或多个entry具有指定的value.
`Set<Map.Entry<K,V>>`	`entrySet()` 取得entry的集合视图.
`protected static boolean`	`eq(Object x, Object y)` 比较两个对象.
`V`	`get(Object key)` 返回指定key对应的value.
`protected int`	`getCapacity()` 取得hash表的容量.
`protected DefaultHashMap.Entry<K,V>`	`getEntry(Object key)` 返回指定key对应的entry.
`protected float`	`getLoadFactor()` 取得hash表的负载系数.
`protected int`	`getThreshold()` 取得hash表的阈值.
`protected static int`	`hash(Object obj)` 返回对象的hash值.
`protected static int`	`indexFor(int hash, int length)` 返回索引值, 根据指定的hash值和数组的长度.
`boolean`	`isEmpty()` 判断是否为空的hash表.
`Set<K>`	`keySet()` 取得key的集合视图.
`protected Iterator<Map.Entry<K,V>>`	`newEntryIterator()` 子类覆盖此方法, 用来创建entry的遍历器.
`protected Iterator<K>`	`newKeyIterator()` 子类覆盖此方法, 用来创建key的遍历器.
`protected Iterator<V>`	`newValueIterator()` 子类覆盖此方法, 用来创建value的遍历器.
`protected void`	`onInit()` 给子类一个机会初始化自己.
`V`	`put(K key, V value)` 将指定的value和key关联.
`void`	`putAll(Map<? extends K,? extends V> map)` 将Map中的所有项都加入到当前的Map中.
`V`	`remove(Object key)` 将指定key的entry从hash表中删除(如果该entry存在的话).
`protected DefaultHashMap.Entry<K,V>`	`removeEntry(Object o)` 删除指定的entry.
`protected DefaultHashMap.Entry<K,V>`	`removeEntryForKey(Object key)` 删除指定key对应的entry, 并返回被删除的entry.
`protected void`	`resize(int newCapacity)` 对map进行扩容.
`int`	`size()` 返回hash表中entry的个数.
`protected void`	`transfer(DefaultHashMap.Entry<K,V>[] newTable)` 将所有entry从当前表中移到新表中(扩容).
`Collection<V>`	`values()` 取得value的集合视图.

从类继承的方法 java.util.AbstractMap
equals, hashCode, toString

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

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

- 字段详细资料
  - table
```
protected transient DefaultHashMap.Entry<K,V>[] table
```
    Hash表, 长度可变 - 但长度必须是2的整数次幂.
  - size
```
protected transient int size
```
    Hash表中的entry数.
  - threshold
```
protected int threshold
```
    阈值. 当hash表中的entry数超过它时, 自动扩容(resize). 其值等于 capacity×loadFactor.
  - loadFactor
```
protected final float loadFactor
```
    负载系数.
  - modCount
```
protected transient volatile int modCount
```
    当hash表发生"结构改变"的计数. 所谓"结构改变", 是指hash表中entry的数目发生改变或内部结构改变(如resize). 这个字段是为了实现fail-fast.
- 构造器详细资料
  - DefaultHashMap
```
public DefaultHashMap()
```
    创建一个空的hash表. 使用指定的默认的初始容量(16)和默认的负载系数(0.75).
  - DefaultHashMap
```
public DefaultHashMap(int initialCapacity)
```
    创建一个空的hash表. 使用指定的初始阈值和默认的负载系数(0.75).
    
    参数:
    
    initialCapacity - 初始容量.
  - DefaultHashMap
```
public DefaultHashMap(int initialCapacity,
                      float loadFactor)
```
    创建一个空的hash表. 使用指定的初始容量和负载系数.
    
    参数:
    
    initialCapacity - 初始容量
    
    loadFactor - 负载系数.
  - DefaultHashMap
```
public DefaultHashMap(Map<? extends K,? extends V> map)
```
    复制指定Map内容相同的HashMap. 使用默认的负载系数(0.75).
    
    参数:
    
    map - 要复制的Map
- 方法详细资料
  - size
```
public int size()
```
    返回hash表中entry的个数.
    
    指定者:
    
    size 在接口中 Map<K,V>
    
    覆盖:
    
    size 在类中 AbstractMap<K,V>
    
    返回:
    
    hash表中的entry数.
  - isEmpty
```
public boolean isEmpty()
```
    判断是否为空的hash表.
    
    指定者:
    
    isEmpty 在接口中 Map<K,V>
    
    覆盖:
    
    isEmpty 在类中 AbstractMap<K,V>
    
    返回:
    
    如果为空(size() == 0), 则返回true.
  - get
```
public V get(Object key)
```
    返回指定key对应的value. 如果hash表中没有value对应key, 则返回null. 但是返回 null并不总是代表没有value对应指定的key, 也有可能是指 value值本身为null . 可以通过方法containsKey来区分这两种情况.
    
    指定者:
    
    get 在接口中 Map<K,V>
    
    覆盖:
    
    get 在类中 AbstractMap<K,V>
    
    参数:
    
    key - 指定key所对应的value将被返回.
    
    返回:
    
    指定key对应的value, 如果没有value对应此key, 则返回null.
  - containsKey
```
public boolean containsKey(Object key)
```
    如果hash表中包含指定key的entry, 则返回true.
    
    指定者:
    
    containsKey 在接口中 Map<K,V>
    
    覆盖:
    
    containsKey 在类中 AbstractMap<K,V>
    
    参数:
    
    key - 测试指定的key是否存在.
    
    返回:
    
    如果key对应的entry存在, 则返回true.
  - put
```
public V put(K key,
             V value)
```
    将指定的value和key关联. 如果已经有value和此key相关联, 则取代之, 并返回被取代的value.
    
    指定者:
    
    put 在接口中 Map<K,V>
    
    覆盖:
    
    put 在类中 AbstractMap<K,V>
    
    参数:
    
    key - 要关联的key
    
    value - 要和key关联的value
    
    返回:
    
    如果已经存在和此key相关联的value, 则返回此value. 否则返回null. 返回 null也可能是因为被取代的这个value值为 null.
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
    将Map中的所有项都加入到当前的Map中. 如果有相同的key, 则替换之.
    
    指定者:
    
    putAll 在接口中 Map<K,V>
    
    覆盖:
    
    putAll 在类中 AbstractMap<K,V>
    
    参数:
    
    map - 要加入的Map
  - remove
```
public V remove(Object key)
```
    将指定key的entry从hash表中删除(如果该entry存在的话).
    
    指定者:
    
    remove 在接口中 Map<K,V>
    
    覆盖:
    
    remove 在类中 AbstractMap<K,V>
    
    参数:
    
    key - 要被删除的entry的key
    
    返回:
    
    被删除的entry的value. 如果entry不存在, 则返回null. 但是返回 null并不总是代表没有value对应指定的key, 也有可能是指 value值本身为 null.
  - clear
```
public void clear()
```
    清除hash表中的所有entry.
    
    指定者:
    
    clear 在接口中 Map<K,V>
    
    覆盖:
    
    clear 在类中 AbstractMap<K,V>
  - containsValue
```
public boolean containsValue(Object value)
```
    判断hash表中是否有一个或多个entry具有指定的value.
    
    指定者:
    
    containsValue 在接口中 Map<K,V>
    
    覆盖:
    
    containsValue 在类中 AbstractMap<K,V>
    
    参数:
    
    value - 要测试的value
    
    返回:
    
    如果有一个或多个entry具有指定的value, 则返回true
  - keySet
```
public Set<K> keySet()
```
    取得key的集合视图. 这个集合是以hash表为基础的, 任何hash表的改变, 都会反射到这个集合, 反之亦然. 该集合支持删除操作, 删除集合中的key就删除了hash表中的相应entry. 可以通过以下方法删除一个entry: Iterator.remove, Set.remove, removeAll, retainAll, 和clear. 但集合不支持add或addAll操作.
    
    指定者:
    
    keySet 在接口中 Map<K,V>
    
    覆盖:
    
    keySet 在类中 AbstractMap<K,V>
    
    返回:
    
    key的集合视图
  - values
```
public Collection<V> values()
```
    取得value的集合视图. 这个集合是以hash表为基础的, 任何hash表的改变, 都会反射到这个集合, 反之亦然. 该集合支持删除操作, 删除集合中的key就删除了hash表中的相应entry. 可以通过以下方法删除一个entry: Iterator.remove, Collection.remove, removeAll, retainAll, 和clear. 但集合不支持add或addAll操作.
    
    指定者:
    
    values 在接口中 Map<K,V>
    
    覆盖:
    
    values 在类中 AbstractMap<K,V>
    
    返回:
    
    value的集合视图
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    取得entry的集合视图. 这个集合是以hash表为基础的, 任何hash表的改变, 都会反射到这个集合, 反之亦然. 该集合支持删除操作, 删除集合中的key就删除了hash表中的相应entry. 可以通过以下方法删除一个entry: Iterator.remove, Set.remove, removeAll, retainAll, 和clear. 但集合不支持add或addAll操作.
    
    指定者:
    
    entrySet 在接口中 Map<K,V>
    
    指定者:
    
    entrySet 在类中 AbstractMap<K,V>
    
    返回:
    
    entry的集合视图
  - clone
```
public Object clone()
```
    "浅"拷贝hash表, key和value本身并不被复制.
    
    覆盖:
    
    clone 在类中 AbstractMap<K,V>
    
    返回:
    
    被复制的hash表.
  - onInit
```
protected void onInit()
```
    给子类一个机会初始化自己. 该方法被所有构造函数以及"伪构造函数"(clone, readObject)调用. 调用时, hash表已被初始化, 但数据尚未被插入到表中.
  - getEntry
```
protected DefaultHashMap.Entry<K,V> getEntry(Object key)
```
    返回指定key对应的entry. 如果不存在, 则返回null.
    
    参数:
    
    key - 返回指定key对应的entry
    
    返回:
    
    指定key对应的entry
  - addEntry
```
protected void addEntry(K key,
                        V value)
```
    加入一个entry到hash表中, 但不会对hash表进行resize()操作. 子类可以覆盖此方法, 以改变 put, new HashMap(Map), clone, 和 readObject方法的行为.
    
    参数:
    
    key - hash表的key
    
    value - hash表的value
  - removeEntryForKey
```
protected DefaultHashMap.Entry<K,V> removeEntryForKey(Object key)
```
    删除指定key对应的entry, 并返回被删除的entry.
    
    参数:
    
    key - 要删除的entry的key
    
    返回:
    
    被删除的entry, 如果entry不存在, 则返回null
  - removeEntry
```
protected DefaultHashMap.Entry<K,V> removeEntry(Object o)
```
    删除指定的entry. 这个方法用于EntrySet.remove.
    
    参数:
    
    o - 要删除的entry
    
    返回:
    
    被删除的entry
  - newKeyIterator
```
protected Iterator<K> newKeyIterator()
```
    子类覆盖此方法, 用来创建key的遍历器.
    
    返回:
    
    hash表的key的遍历器
  - newValueIterator
```
protected Iterator<V> newValueIterator()
```
    子类覆盖此方法, 用来创建value的遍历器.
    
    返回:
    
    hash表的key的遍历器
  - newEntryIterator
```
protected Iterator<Map.Entry<K,V>> newEntryIterator()
```
    子类覆盖此方法, 用来创建entry的遍历器.
    
    返回:
    
    hash表的key的遍历器
  - hash
```
protected static int hash(Object obj)
```
    返回对象的hash值.
    
    参数:
    
    obj - 取得指定对象的hash值
    
    返回:
    
    指定对象的hash值
  - eq
```
protected static boolean eq(Object x,
                            Object y)
```
    比较两个对象.
    
    参数:
    
    x - 第一个对象
    
    y - 第二个对象
    
    返回:
    
    如果相同, 则返回true
  - indexFor
```
protected static int indexFor(int hash,
                              int length)
```
    返回索引值, 根据指定的hash值和数组的长度.
    
    参数:
    
    hash - hash值
    
    length - 数组的长度, 必然是2的整数次幂
    
    返回:
    
    hash值在数组中的序号
  - resize
```
protected void resize(int newCapacity)
```
    对map进行扩容. 此方法在entry数超过阈值时被调用.
    
    参数:
    
    newCapacity - 新的容量(必须为2的整数次幂).
  - transfer
```
protected void transfer(DefaultHashMap.Entry<K,V>[] newTable)
```
    将所有entry从当前表中移到新表中(扩容).
    
    参数:
    
    newTable - 新表
  - getCapacity
```
protected int getCapacity()
```
    取得hash表的容量.
    
    返回:
    
    hash表的容量
  - getLoadFactor
```
protected float getLoadFactor()
```
    取得hash表的负载系数.
    
    返回:
    
    hash表的负载系数
  - getThreshold
```
protected int getThreshold()
```
    取得hash表的阈值.
    
    返回:
    
    hash表的阈值

类 DefaultHashMap<K,V>

嵌套类概要

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

字段概要

构造器概要

方法概要

从类继承的方法 java.util.AbstractMap

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

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

字段详细资料

table

size

threshold

loadFactor

modCount

构造器详细资料

DefaultHashMap

DefaultHashMap

DefaultHashMap

DefaultHashMap

方法详细资料

size

isEmpty

get

containsKey

put

putAll

remove

clear

containsValue

keySet

values

entrySet

clone

onInit

getEntry

addEntry

removeEntryForKey

removeEntry

newKeyIterator

newValueIterator

newEntryIterator

hash

eq

indexFor

resize

transfer

getCapacity

getLoadFactor

getThreshold