org.javimmutable.collections.common.AbstractJImmutableSet Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2017, 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.common;

import org.javimmutable.collections.Cursor;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.JImmutableMultiset;
import org.javimmutable.collections.JImmutableSet;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.cursors.Cursors;

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

@Immutable
public abstract class AbstractJImmutableSet
    implements JImmutableSet
{
    private final JImmutableMap map;

    protected AbstractJImmutableSet(JImmutableMap map)
    {
        this.map = map;
    }

    @Override
    @Nonnull
    public JImmutableSet insert(@Nonnull T value)
    {
        JImmutableMap newMap = map.assign(value, Boolean.TRUE);
        return (newMap != map) ? create(newMap) : this;
    }

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

    @Override
    @Nonnull
    public JImmutableSet insertAll(@Nonnull Iterable values)
    {
        return union(values.iterator());
    }

    @Override
    @Nonnull
    public JImmutableSet insertAll(@Nonnull Cursor values)
    {
        return union(values.iterator());
    }

    @Override
    @Nonnull
    public JImmutableSet insertAll(@Nonnull Iterator values)
    {
        return union(values);
    }

    @Override
    public boolean contains(@Nullable T value)
    {
        return (value != null) && map.getValueOr(value, Boolean.FALSE);
    }

    @Override
    public boolean containsAll(@Nonnull Iterable values)
    {
        return containsAll(values.iterator());
    }

    @Override
    public boolean containsAll(@Nonnull Cursor values)
    {
        for (Cursor c = values.start(); c.hasValue(); c = c.next()) {
            if (!contains(c.getValue())) {
                return false;
            }
        }
        return true;
    }

    @Override
    public boolean containsAll(@Nonnull Iterator values)
    {
        while (values.hasNext()) {
            if (!contains(values.next())) {
                return false;
            }
        }
        return true;
    }

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

    @Override
    public boolean containsAny(@Nonnull Cursor values)
    {
        for (Cursor c = values.start(); c.hasValue(); c = c.next()) {
            if (contains(c.getValue())) {
                return true;
            }
        }
        return false;
    }

    @Override
    public boolean containsAny(@Nonnull Iterator values)
    {
        while (values.hasNext()) {
            if (contains(values.next())) {
                return true;
            }
        }
        return false;
    }

    @Nonnull
    @Override
    public JImmutableSet delete(T value)
    {
        JImmutableMap newMap = map.delete(value);
        return (newMap != map) ? create(newMap) : this;
    }

    @Nonnull
    @Override
    public JImmutableSet deleteAll(@Nonnull Iterable other)
    {
        return deleteAll(other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet deleteAll(@Nonnull Cursor values)
    {
        return deleteAll(values.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet deleteAll(@Nonnull Iterator values)
    {
        JImmutableMap newMap = map;
        while (values.hasNext()) {
            final T value = values.next();
            if (value != null) {
                newMap = newMap.delete(value);
            }
        }
        return (newMap != map) ? create(newMap) : this;
    }

    @Nonnull
    @Override
    public JImmutableSet union(@Nonnull Iterable other)
    {
        return union(other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet union(@Nonnull Cursor values)
    {
        return union(values.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet union(@Nonnull Iterator values)
    {
        JImmutableMap newMap = map;
        while (values.hasNext()) {
            final T value = values.next();
            if (value != null) {
                newMap = newMap.assign(value, Boolean.TRUE);
            }
        }
        return (newMap != map) ? create(newMap) : this;
    }

    @Nonnull
    @Override
    public JImmutableSet intersection(@Nonnull Iterable other)
    {
        return intersection(other.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet intersection(@Nonnull Cursor values)
    {
        return intersection(values.iterator());
    }

    @Nonnull
    @Override
    public JImmutableSet intersection(@Nonnull Iterator values)
    {
        if (isEmpty()) {
            return this;
        }

        if (!values.hasNext()) {
            return deleteAll();
        }

        Set otherSet = emptyMutableSet();
        while (values.hasNext()) {
            final T value = values.next();
            if (value != null) {
                otherSet.add(value);
            }
        }

        JImmutableMap newMap = map;
        for (JImmutableMap.Entry entry : map) {
            if (!otherSet.contains(entry.getKey())) {
                newMap = newMap.delete(entry.getKey());
            }
        }

        return (newMap != map) ? create(newMap) : this;
    }

    @Nonnull
    @Override
    public JImmutableSet intersection(@Nonnull JImmutableSet other)
    {
        return intersection(other.getSet());
    }

    @Nonnull
    @Override
    public JImmutableSet intersection(@Nonnull Set other)
    {
        if (isEmpty()) {
            return this;
        } else if (other.isEmpty()) {
            return deleteAll();
        } else {
            JImmutableMap newMap = map;
            for (T value : map.keysCursor()) {
                if (!other.contains(value)) {
                    newMap = newMap.delete(value);
                }
            }
            return (newMap != map) ? create(newMap) : this;
        }
    }

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

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

    @Nonnull
    @Override
    public Set getSet()
    {
        return SetAdaptor.of(this);
    }

    @Override
    @Nonnull
    public Cursor cursor()
    {
        return map.keysCursor();
    }

    @Nonnull
    @Override
    public SplitableIterator iterator()
    {
        return map.keys().iterator();
    }

    @Override
    public int getSpliteratorCharacteristics()
    {
        return map.keys().getSpliteratorCharacteristics();
    }

    @Override
    public int hashCode()
    {
        return Cursors.computeHashCode(cursor());
    }

    @Override
    public boolean equals(Object o)
    {
        if (o == this) {
            return true;
        } else if (o == null) {
            return false;
        } else if (o instanceof JImmutableMultiset) {
            return o.equals(this);
        } else if (o instanceof JImmutableSet) {
            return getSet().equals(((JImmutableSet)o).getSet());
        } else {
            return (o instanceof Set) && getSet().equals(o);
        }
    }

    @Override
    public String toString()
    {
        return Cursors.makeString(cursor());
    }

    @Override
    public void checkInvariants()
    {
        checkSetInvariants();
    }

    protected void checkSetInvariants()
    {
        map.checkInvariants();
        for (JImmutableMap.Entry entry : map.cursor()) {
            if (!entry.getValue()) {
                throw new RuntimeException();
            }
        }
    }

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

    /**
     * Implemented by derived classes to create a new empty Set
     */
    protected abstract Set emptyMutableSet();
}