org.javimmutable.collections.setmap.AbstractJImmutableSetMap 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.
There is a newer version: 3.2.1
Show newest version
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2019, 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.setmap;


import org.javimmutable.collections.Holder;
import org.javimmutable.collections.IterableStreamable;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.JImmutableSet;
import org.javimmutable.collections.JImmutableSetMap;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.common.Conditions;
import org.javimmutable.collections.common.StreamConstants;
import org.javimmutable.collections.iterators.EntryIterableStreamable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.util.Iterator;
import java.util.Set;

@Immutable
abstract class AbstractJImmutableSetMap
    implements JImmutableSetMap
{
    protected final JImmutableSet emptySet;
    protected final JImmutableMap> contents;

    protected AbstractJImmutableSetMap(JImmutableMap> contents,
                                       JImmutableSet emptySet)
    {
        this.emptySet = emptySet;
        this.contents = contents;
    }

    @Nonnull
    @Override
    public JImmutableSet getSet(@Nonnull K key)
    {
        Conditions.stopNull(key);
        return contents.getValueOr(key, emptySet);
    }

    @Nonnull
    @Override
    public JImmutableSetMap assign(@Nonnull K key,
                                         @Nonnull JImmutableSet value)
    {
        Conditions.stopNull(key, value);
        return create(contents.assign(key, value));
    }

    @Nonnull
    @Override
    public JImmutableSetMap insert(@Nonnull K key,
                                         @Nonnull V value)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).insert(value)));
    }

    @Nonnull
    @Override
    public JImmutableSetMap insertAll(@Nonnull K key,
                                            @Nonnull Iterable values)
    {
        return insertAll(key, values.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSetMap insertAll(@Nonnull K key,
                                            @Nonnull Iterator values)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).insertAll(values)));
    }

    @Nonnull
    @Override
    public JImmutableSetMap getInsertableSelf()
    {
        return this;
    }

    @Override
    public boolean contains(@Nonnull K key)
    {
        return contents.find(key).isFilled();
    }

    @Override
    public boolean contains(@Nonnull K key,
                            @Nullable V value)
    {
        return getSet(key).contains(value);
    }

    @Override
    public boolean containsAll(@Nonnull K key,
                               @Nonnull Iterable values)
    {
        return containsAll(key, values.iterator());

    }

    @Override
    public boolean containsAll(@Nonnull K key,
                               @Nonnull Iterator values)
    {
        return contains(key) && getSet(key).containsAll(values);
    }

    @Override
    public boolean containsAny(@Nonnull K key,
                               @Nonnull Iterable values)
    {
        return containsAny(key, values.iterator());
    }

    @Override
    public boolean containsAny(@Nonnull K key,
                               @Nonnull Iterator values)
    {
        return getSet(key).containsAny(values);
    }

    @Nonnull
    @Override
    public JImmutableSetMap delete(@Nonnull K key)
    {
        return create(contents.delete(key));
    }

    @Nonnull
    @Override
    public JImmutableSetMap delete(@Nonnull K key,
                                         @Nonnull V value)
    {
        JImmutableSet set = getSet(key);
        return set.contains(value) ? create(contents.assign(key, set.delete(value))) : this;
    }

    @Nonnull
    @Override
    public JImmutableSetMap deleteAll(@Nonnull K key,
                                            @Nonnull Iterable other)
    {
        return deleteAll(key, other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSetMap deleteAll(@Nonnull K key,
                                            @Nonnull Iterator other)
    {
        JImmutableSet set = getSet(key);
        return set.isEmpty() ? this : create(contents.assign(key, set.deleteAll(other)));
    }

    @Nonnull
    @Override
    public JImmutableSetMap union(@Nonnull K key,
                                        @Nonnull Iterable other)
    {
        return union(key, other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSetMap union(@Nonnull K key,
                                        @Nonnull Iterator other)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).union(other)));
    }


    @Nonnull
    @Override
    public JImmutableSetMap intersection(@Nonnull K key,
                                               @Nonnull Iterable other)
    {
        return intersection(key, other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSetMap intersection(@Nonnull K key,
                                               @Nonnull Iterator other)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).intersection(other)));
    }

    @Nonnull
    @Override
    public JImmutableSetMap intersection(@Nonnull K key,
                                               @Nonnull JImmutableSet other)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).intersection(other)));
    }

    @Nonnull
    @Override
    public JImmutableSetMap intersection(@Nonnull K key,
                                               @Nonnull Set other)
    {
        return create(contents.update(key, h -> h.getValueOr(emptySet).intersection(other)));
    }

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

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

    @Override
    @Nonnull
    public JImmutableSetMap insert(@Nonnull JImmutableMap.Entry e)
    {
        return insert(e.getKey(), e.getValue());
    }

    @Nonnull
    @Override
    public SplitableIterator>> iterator()
    {
        return contents.iterator();
    }

    @Override
    public int getSpliteratorCharacteristics()
    {
        return StreamConstants.SPLITERATOR_ORDERED;
    }

    @Nonnull
    @Override
    public IterableStreamable keys()
    {
        return contents.keys();
    }

    @Nonnull
    @Override
    public IterableStreamable values(@Nonnull K key)
    {
        return getSet(key);
    }

    @Nullable
    @Override
    public JImmutableSet get(K key)
    {
        return contents.get(key);
    }

    @Override
    public JImmutableSet getValueOr(K key,
                                       JImmutableSet defaultValue)
    {
        return contents.getValueOr(key, defaultValue);
    }

    @Nonnull
    @Override
    public Holder> find(K key)
    {
        return contents.find(key);
    }

    @Nonnull
    @Override
    public JImmutableSetMap deleteAll()
    {
        return create(contents.deleteAll());
    }

    @Nonnull
    @Override
    public IterableStreamable> entries()
    {
        return new EntryIterableStreamable<>(this);
    }

    @Override
    public int hashCode()
    {
        return contents.hashCode();
    }

    @Override
    public boolean equals(Object o)
    {
        return (o instanceof AbstractJImmutableSetMap) && contents.equals(((AbstractJImmutableSetMap)o).contents);
    }

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

    protected void checkSetMapInvariants()
    {
        contents.checkInvariants();
        for (JImmutableMap.Entry> entry : contents) {
            entry.getValue().checkInvariants();
        }
    }

    /**
     * Implemented by derived classes to create a new instance of the appropriate class.
     */
    protected abstract JImmutableSetMap create(JImmutableMap> map);
}