CopyOnWriteCaseInsensitiveMap.java

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.util;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import java.util.AbstractSet;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

/**
 * Implementation of {@link Map} that provides copy on write semantics while providing the case-insensitivity
 * of {@link CaseInsensitiveHashMap}. <br>
 * <b>Note:</b> In this {@link Map} implementation {@link #values()} and {@link #entrySet()} return
 * unmodifiable {@link Collection}'s.<br>
 * This implementation is not thread-safe.
 */
public class CopyOnWriteCaseInsensitiveMap<K, V> implements Map<K, V>, Serializable
{

    private static final long serialVersionUID = -2753436627413265538L;

    private Map<K, V> core;
    private transient Map<K, V> view;
    private transient boolean requiresCopy;
    private transient Set<K> keyset = new KeySet();

    @SuppressWarnings("unchecked")
    public CopyOnWriteCaseInsensitiveMap()
    {
        updateCore(new CaseInsensitiveHashMap());
    }

    private CopyOnWriteCaseInsensitiveMap(CopyOnWriteCaseInsensitiveMap<K, V> that)
    {
        updateCore(that.core);
        this.requiresCopy = true;
    }

    @SuppressWarnings({"rawtypes", "unchecked"})
    @Override
    public CopyOnWriteCaseInsensitiveMap<K, V> clone()
    {
        try
        {
            return new CopyOnWriteCaseInsensitiveMap(this);
        }
        finally
        {
            requiresCopy = true;
        }
    }

    @SuppressWarnings("unchecked")
    private void copy()
    {
        if (requiresCopy)
        {
            updateCore(new CaseInsensitiveHashMap(core));
            requiresCopy = false;
        }
    }

    @Override
    public int size()
    {
        return core.size();
    }

    @Override
    public boolean isEmpty()
    {
        return core.isEmpty();
    }

    @Override
    public boolean containsKey(Object key)
    {
        return core.containsKey(key);
    }

    @Override
    public boolean containsValue(Object value)
    {
        return core.containsValue(value);
    }

    @Override
    public V get(Object key)
    {
        return core.get(key);
    }

    @Override
    public V put(K key, V value)
    {
        copy();
        return core.put(key, value);
    }

    @Override
    public V remove(Object key)
    {
        copy();
        return core.remove(key);
    }

    @Override
    public void putAll(Map<? extends K, ? extends V> t)
    {
        copy();
        core.putAll(t);
    }

    @SuppressWarnings("unchecked")
    @Override
    public void clear()
    {
        updateCore(new CaseInsensitiveHashMap());
    }

    public Set<K> keySet()
    {
        return keyset;
    }

    private final class KeySet extends AbstractSet<K>
    {
        public Iterator<K> iterator()
        {
            return new KeyIterator();
        }

        public int size()
        {
            return CopyOnWriteCaseInsensitiveMap.this.size();
        }

        public boolean contains(Object o)
        {
            return containsKey(o);
        }

        public boolean remove(Object o)
        {
            return CopyOnWriteCaseInsensitiveMap.this.remove(o) != null;
        }

        public void clear()
        {
            CopyOnWriteCaseInsensitiveMap.this.clear();
        }
    }

    private final class KeyIterator implements Iterator<K>
    {
        private int current;
        private K[] keyArray;

        @SuppressWarnings("unchecked")
        public KeyIterator()
        {
            keyArray = (K[]) core.keySet().toArray();
        }

        public boolean hasNext()
        {
            return current < keyArray.length;
        }

        public K next()
        {
            return keyArray[current++];
        }

        public void remove()
        {
            CopyOnWriteCaseInsensitiveMap.this.remove(keyArray[current]);
        }
    }

    @Override
    public Collection<V> values()
    {
        return view.values();
    }

    @Override
    public Set<Entry<K, V>> entrySet()
    {
        return view.entrySet();
    }

    @Override
    public String toString()
    {
        return core.toString();
    }

    private void updateCore(Map<K, V> core)
    {
        this.core = core;
        this.view = Collections.unmodifiableMap(core);
    }

    /**
     * After deserialization we can just use unserialized original map directly.
     */
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
    {
        in.defaultReadObject();
        this.view = Collections.unmodifiableMap(core);
        this.keyset = new KeySet();
    }

}