EnumMap

EnumMap是Map接口的一种实现,专门用于枚举类型的键,所有枚举的键必须来自同一个枚举

EnumMap不允许键为空,允许值为空

EnumMap成员变量

    private final Class<K> keyType;

    private transient K[] keyUniverse;

    private transient Object[] vals;

    private transient int size = 0;

    private static final Object NULL = new Object() {
    public int hashCode() {
        return 0;
    }
    public String toString() {
        return "java.util.EnumMap.NULL";
    }
};

其中有一个特别的数据类型它是Object实例NULL,用于取代真正的NULL值

下面是几个常用的方法源码解读

put

public V put(K key, V value) {
    typeCheck(key);
    int index = key.ordinal();
    Object oldValue = vals[index];
    vals[index] = maskNull(value);
    if (oldValue == null)
        size++;
    return unmaskNull(oldValue);
}

EnumMap key必须来自同一个枚举,在向EnumMap存放数据的时候,首先进行类型检查

private void typeCheck(K key) {
    Class<?> keyClass = key.getClass();
    if (keyClass != keyType && keyClass.getSuperclass() != keyType)
        throw new ClassCastException(keyClass + " != " + keyType);
}

然后获取该枚举的索引值以该索引为vals数组的索引存放数据

检查的逻辑是判断当前类和父类是否是指定的枚举类型,如果不是会抛出ClassCastException
类型检查之后,存放数据,数据的存放在EnumMap中对null型数据有额外的操作

private Object maskNull(Object value) {
    return (value == null ? NULL : value);
}
@SuppressWarnings("unchecked")
private V unmaskNull(Object value) {
    return (V)(value == NULL ? null : value);
}

如果存放null值,EnumMap会将其替换成一个重写了toString和hashcode的Object
如下代码所示

private static final Object NULL = new Object() {
    public int hashCode() {
        return 0;
    }
    public String toString() {
        return "java.util.EnumMap.NULL";
    }
};

取数据的时候如果是上面的NULL,那么进行unmask操作

get

public V get(Object key) {
    return (isValidKey(key) ?
            unmaskNull(vals[((Enum<?>)key).ordinal()]) : null);
}

get方法很简单,首先判断key值是否合理

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;
}

判断key的类型或者key的父类型是否与指定的EnumMap的键值类型相同

然后判断vals中的值是否为NULL,如果是进行unmask转换