EnumMap源代码阅读器
EnumMap是一个用于存放键值为enum类型的map。全部的键值必须来自一个单一的enum类型。EnumMap内部用数组表示效率更高。
EnumMap维持键值的自然顺序(即枚举类型常量声明的顺序)，能够通过keySet()和entrySet()方法的集合视图来体现其顺序。
集合视图返回的迭代器是弱一致的：遍历时候不会抛出ConcurrentModificationException。遍历过程中若对容器进行改动。改动产生的影响遍历过程可能可见也可能不可见。
不同意null键值插入，插入空值将会抛出NullPointerException。測试空值是否存在或删除空值操作是同意的。
和其它集合对象实现类似，EnumMap不保证线程安全，能够通过集合帮助类的方法进行包装。返回线程安全的容器。
Map<EnumKey, V> m = Collections.synchronizedMap(new EnumMap<EnumKey, V>(...));EnumMap实现
类的定义。能够看到键值必须是继承Enum<K>对象的实例
public class EnumMap<K extends Enum<K>, V> extends AbstractMap<K, V>
implements java.io.Serializable, Cloneable
成员变量
private final Class<K> keyType; //key相应的class对象
// All of the values comprising K. (Cached for performance.)
private transient K[] keyUniverse;
//Array representation of this map.
private transient Object[] vals;
private transient int size = 0; //map的大小
//用非空值对象来表示null
private static final Object NULL = new Object();构造方法
public EnumMap(Class<K> keyType) {
this.keyType = keyType;
keyUniverse = getKeyUniverse(keyType);
vals = new Object[keyUniverse.length];
}
/**
* Returns all of the values comprising K.
* The result is uncloned, cached, and shared by all callers.
* 调用sun.misc.SharedSecrets类中方法返回相应枚举类的成员
*/
private static <K extends Enum<K>> K[] getKeyUniverse(Class<K> keyType) {
return SharedSecrets.getJavaLangAccess()
.getEnumConstantsShared(keyType);
}put和remove方法
public V put(K key, V value) {
typeCheck(key);
int index = ((Enum)key).ordinal();
Object oldValue = vals[index];
vals[index] = maskNull(value);
if (oldValue == null)
size++;
return unmaskNull(oldValue);
}
//检查是否为初始化时传入的枚举类型或其子类型(? extends K)
private void typeCheck(K key) {
Class keyClass = key.getClass();
if (keyClass != keyType && keyClass.getSuperclass() != keyType)
throw new ClassCastException(keyClass + " != " + keyType);
}
private Object maskNull(Object value) {
return (value == null ? NULL : value);
}
private V unmaskNull(Object value) {
return (V) (value == NULL ?
null : value);
}
public V remove(Object key) {
if (!isValidKey(key))
return null;
int index = ((Enum)key).ordinal();
Object oldValue = vals[index];
vals[index] = null;
if (oldValue != null)
size--;
return unmaskNull(oldValue);
}
get方法
public V get(Object key) {
return (isValidKey(key) ?
unmaskNull(vals[((Enum)key).ordinal()]) : null);
}
private boolean isValidKey(Object key) {
if (key == null)
return false;
// Cheaper than instanceof Enum followed by getDeclaringClass
Class keyClass = key.getClass();
return keyClass == keyType || keyClass.getSuperclass() == keyType;
}查找方法
public boolean containsKey(Object key) {
return isValidKey(key) && vals[((Enum)key).ordinal()] != null;
}
//即使是value为null，因为内部调用maskNull所以不会有空指针异常
private boolean containsMapping(Object key, Object value) {
return isValidKey(key) &&
maskNull(value).equals(vals[((Enum)key).ordinal()]);
}
public boolean containsValue(Object value) {
value = maskNull(value);
for (Object val : vals)
if (value.equals(val))
return true;
return false;
}集合视图
和HashMap类似，提供keySet()、values()、entrySet()方法。返回键集合、值集合、键值对集合视图。以下介绍下键集合视图，因为这些视图是无状态的，不是必需每次都又一次创建。ketSet方法返回一个内部类EnumMap$KeySet实例。
public Set<K> keySet() {
Set<K> ks = keySet;
if (ks != null)
return ks;
else
return keySet = new KeySet();
}
private class KeySet extends AbstractSet<K> {
public Iterator<K> iterator() {
return new KeyIterator();
}
public int size() {
return size;
}
public boolean contains(Object o) {
return containsKey(o);
}
public boolean remove(Object o) {
int oldSize = size;
EnumMap.this.remove(o);
return size != oldSize;
}
public void clear() {
EnumMap.this.clear();
}
}
视图的迭代器
KeySet的迭代器返回内部类KeyIterator实例，其继承自EnumMapIterator,实际EnumMapIterator实现了整个Entry的迭代，依据不同视图。next方法返回键、值或键值对。
内部没有检查遍历过程是否改动，所以不会抛异常。
private class KeyIterator extends EnumMapIterator<K> {
public K next() {
if (!hasNext())
throw new NoSuchElementException();
lastReturnedIndex = index++;
return keyUniverse[lastReturnedIndex];
}
}
private class ValueIterator extends EnumMapIterator<V> {
public V next() {
if (!hasNext())
throw new NoSuchElementException();
lastReturnedIndex = index++;
return unmaskNull(vals[lastReturnedIndex]);
}
}
private abstract class EnumMapIterator<T> implements Iterator<T> {
// Lower bound on index of next element to return
int index = 0;
// Index of last returned element, or -1 if none
int lastReturnedIndex = -1;
public boolean hasNext() {
while (index < vals.length && vals[index] == null)
index++;
return index != vals.length;
}
public void remove() {
checkLastReturnedIndex();
if (vals[lastReturnedIndex] != null) {
vals[lastReturnedIndex] = null;
size--;
}
lastReturnedIndex = -1;
}
private void checkLastReturnedIndex() {
if (lastReturnedIndex < 0)
throw new IllegalStateException();
}
}总结
EnumMap的键值必须是Enum类型。并且put的时候仅仅能是初始化时指定的Enum或者其子类型。同一时候不支持键值为null。EnumMap初始化会创建存放key和value的两个数组，大小为Enum类型中成员数量，同一时候会缓存全部Enum类型到key数组。EnumMap迭代保持键值的自然顺序(即枚举类型常量声明的顺序)，事实上通过Enum内部ordinal()方法实现，vals数组每次插入元素都放插入到key值相应的ordinal()返回地点。
版权声明：本文博主原创文章，博客，未经同意不得转载。
