org.javimmutable.collections.listmap.AbstractJImmutableListMap 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.listmap;

import org.javimmutable.collections.Cursor;
import org.javimmutable.collections.Holder;
import org.javimmutable.collections.IterableStreamable;
import org.javimmutable.collections.JImmutableList;
import org.javimmutable.collections.JImmutableListMap;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.common.Conditions;
import org.javimmutable.collections.list.JImmutableArrayList;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

@Immutable
public abstract class AbstractJImmutableListMap
    implements JImmutableListMap
{
    private final JImmutableMap> contents;

    protected AbstractJImmutableListMap(JImmutableMap> contents)
    {
        this.contents = contents;
    }

    @Nonnull
    @Override
    public JImmutableList getList(@Nonnull K key)
    {
        Conditions.stopNull(key);
        Holder> current = contents.find(key);
        return current.isFilled() ? current.getValue() : emptyList();
    }

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

    @Nonnull
    @Override
    public JImmutableListMap insert(@Nonnull K key,
                                          @Nullable V value)
    {
        return create(contents.assign(key, insertInList(getList(key), value)));
    }

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

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

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

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

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

    @Nonnull
    @Override
    public Cursor valuesCursor(@Nonnull K key)
    {
        return getList(key).cursor();
    }

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

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

    @Override
    @Nonnull
    public Cursor>> cursor()
    {
        return contents.cursor();
    }

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

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

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

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

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

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

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

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

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

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

    protected void checkListMapInvariants()
    {
        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 JImmutableListMap create(JImmutableMap> map);

    /**
     * Overridable by derived classes to create a compatible copy of the specified list.
     * Default implementation simply returns the original.
     */
    protected JImmutableList copyList(JImmutableList original)
    {
        return original;
    }

    /**
     * Overridable by derived classes to create a new empty list
     */
    @Nonnull
    protected JImmutableList emptyList()
    {
        return JImmutableArrayList.of();
    }

    /**
     * Overridable by derived classes to insert a value into a list in some way.
     * Default implementation appends to end of the list.
     */
    @Nonnull
    protected JImmutableList insertInList(JImmutableList list,
                                             V value)
    {
        return list.insertLast(value);
    }
}