org.javimmutable.collections.util.MutableMapAdaptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javimmutable-collections Show documentation
Library providing immutable/persistent collection classes for Java. While collections are immutable they provide methods for adding and removing values by creating new modified copies of themselves. Each copy shares almost all of its structure with other copies to minimize memory consumption.
The newest version!
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2021, Burton Computer Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//     Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//     Neither the name of the Burton Computer Corporation nor the names
//     of its contributors may be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.javimmutable.collections.util;

import org.javimmutable.collections.JImmutableMap;

import javax.annotation.Nonnull;
import java.util.AbstractMap;
import java.util.AbstractSet;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

/**
 * When converting legacy code to use JImmutableMap there are sometimes objects that shared the mutable
 * version of their internal Map field with other classes.  This class serves as an adaptor to allow
 * this sharing to continue for a time after converting to JImmutableMap.  However the legacy code should
 * still be changed over time to eliminate the sharing of a mutable Map.
 * 
 * Since a JImmutableMap has to be replaced to reflect any changes to the map it can be difficult to
 * adapt one of them into a mutable Map.  Concrete classes derived from this class only have to implement
 * two methods, accessMap() and replaceMap() in order to implement the adaptor.
 * 
 * NOTE: this adaptor is NOT thread safe.  Do not use it in a multi-threaded environment.
 */
public abstract class MutableMapAdaptor
    extends AbstractMap
{
    private final Set> entries;

    protected MutableMapAdaptor()
    {
        this.entries = new MutableEntrySet();
    }

    /**
     * Implemented by derived classes to allow this adaptor to access their JImmutableMap instance.
     */
    protected abstract JImmutableMap accessMap();

    /**
     * Implemented by derived classes to allow this adaptor to replace their JImmutableMap instance.
     */
    protected abstract void replaceMap(JImmutableMap newMap);

    @Nonnull
    @Override
    public Set> entrySet()
    {
        return this.entries;
    }

    @Override
    public V put(K key,
                 V value)
    {
        V oldValue = accessMap().get(key);
        replaceMap(accessMap().assign(key, value));
        return oldValue;
    }

    private class MutableEntrySet
        extends AbstractSet>
    {
        @Nonnull
        @Override
        public Iterator> iterator()
        {
            return new MutableEntryIterator();
        }

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

        @Override
        public boolean add(Entry newEntry)
        {
            replaceMap(accessMap().assign(newEntry.getKey(), newEntry.getValue()));
            return true;
        }

        @SuppressWarnings("unchecked")
        @Override
        public boolean remove(Object o)
        {
            final Map.Entry entry = (Entry)o;
            final K key = entry.getKey();
            if (accessMap().findEntry(key).isFilled()) {
                replaceMap(accessMap().delete(key));
                return true;
            } else {
                return false;
            }
        }

        @SuppressWarnings("unchecked")
        @Override
        public boolean contains(Object o)
        {
            final Map.Entry entry = (Entry)o;
            final K key = entry.getKey();
            return (accessMap().find(key).isFilled());
        }

        @Override
        public void clear()
        {
            replaceMap(accessMap().deleteAll());
        }
    }

    private class MutableEntryIterator
        implements Iterator>
    {
        private JImmutableMap startingMap;
        private Iterator> iter;
        private K currentKey;

        private MutableEntryIterator()
        {
            startingMap = accessMap();
            iter = startingMap.iterator();
        }

        @Override
        public boolean hasNext()
        {
            if (accessMap() != startingMap) {
                throw new ConcurrentModificationException();
            }
            return iter.hasNext();
        }

        @Override
        public Entry next()
        {
            if (accessMap() != startingMap) {
                throw new ConcurrentModificationException();
            }
            final JImmutableMap.Entry entry = iter.next();
            currentKey = entry.getKey();
            return new MutableMapEntry(entry);
        }

        @Override
        public void remove()
        {
            if (accessMap() != startingMap) {
                throw new ConcurrentModificationException();
            }
            replaceMap(accessMap().delete(currentKey));
            startingMap = accessMap();
        }

        private class MutableMapEntry
            extends AbstractMap.SimpleEntry
        {
            private MutableMapEntry(JImmutableMap.Entry entry)
            {
                super(entry.getKey(), entry.getValue());
            }

            @Override
            public V setValue(V newValue)
            {
                if (accessMap() != startingMap) {
                    throw new ConcurrentModificationException();
                }
                replaceMap(accessMap().assign(getKey(), newValue));
                V answer = super.setValue(newValue);
                startingMap = accessMap();
                return answer;
            }
        }
    }
}