org.javimmutable.collections.array.JImmutableTrieArray 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.array;

import org.javimmutable.collections.Holder;
import org.javimmutable.collections.IndexedProc1;
import org.javimmutable.collections.IndexedProc1Throws;
import org.javimmutable.collections.IterableStreamable;
import org.javimmutable.collections.JImmutableArray;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.Proc1Throws;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.common.ArrayToMapAdaptor;
import org.javimmutable.collections.common.StreamConstants;
import org.javimmutable.collections.iterators.IteratorHelper;
import org.javimmutable.collections.iterators.TransformIterator;
import org.javimmutable.collections.serialization.JImmutableArrayProxy;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;
import java.util.function.Consumer;
import java.util.stream.Collector;

import static org.javimmutable.collections.MapEntry.entry;

public class JImmutableTrieArray
    implements Serializable,
               JImmutableArray
{
    @SuppressWarnings({"rawtypes", "unchecked"})
    private static final JImmutableTrieArray EMPTY = new JImmutableTrieArray(TrieArrayNode.empty());
    private static final int SPLITERATOR_CHARACTERISTICS = StreamConstants.SPLITERATOR_ORDERED;

    private final TrieArrayNode root;
    private final int size;

    private JImmutableTrieArray(@Nonnull TrieArrayNode root)
    {
        this.root = root;
        this.size = root.size();
    }

    @SuppressWarnings("unchecked")
    @Nonnull
    public static  JImmutableArray of()
    {
        return (JImmutableArray)EMPTY;
    }

    @Nonnull
    public static  JImmutableArray.Builder builder()
    {
        return new Builder<>();
    }

    @Nonnull
    public static  Collector> collector()
    {
        return Collector., JImmutableArray>of(() -> new Builder<>(),
                                                                                   (b, v) -> b.add(v),
                                                                                   (b1, b2) -> (Builder)b1.add(b2.iterator()),
                                                                                   b -> b.build());
    }

    @Nullable
    @Override
    public T get(int index)
    {
        return getValueOr(index, null);
    }

    @Override
    public T getValueOr(int index,
                        @Nullable T defaultValue)
    {
        return root.getValueOr(index, defaultValue);
    }

    @Nonnull
    @Override
    public Holder find(int index)
    {
        return root.find(index);
    }

    @Nonnull
    @Override
    public Holder> findEntry(int index)
    {
        return find(index).map(v -> entry(index, v));
    }

    @Nonnull
    @Override
    public JImmutableArray assign(int index,
                                     @Nullable T value)
    {
        final TrieArrayNode newChild = root.assign(index, value);
        return new JImmutableTrieArray<>(newChild);
    }

    @Nonnull
    @Override
    public JImmutableArray delete(int index)
    {
        final TrieArrayNode child = root;
        final TrieArrayNode newChild = child.delete(index);
        if (newChild == child) {
            return this;
        } else if (newChild.isEmpty()) {
            return of();
        } else {
            return new JImmutableTrieArray<>(newChild);
        }
    }

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

    @Override
    public boolean isEmpty()
    {
        return size == 0;
    }

    @Override
    public boolean isNonEmpty()
    {
        return size != 0;
    }

    @Nonnull
    @Override
    public JImmutableArray deleteAll()
    {
        return of();
    }

    @Nonnull
    @Override
    public Map getMap()
    {
        return ArrayToMapAdaptor.of(this);
    }

    @Nonnull
    @Override
    public JImmutableArray insert(JImmutableMap.Entry e)
    {
        return (e == null) ? this : assign(e.getKey(), e.getValue());
    }

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

    @Override
    public void checkInvariants()
    {
        root.checkInvariants(null);
        final int computedSize = root.size();
        if (computedSize != size) {
            throw new IllegalStateException(String.format("size mismatch: expected=%d actual=%d", computedSize, this.size));
        }
    }

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

    @Nonnull
    @Override
    public IterableStreamable keys()
    {
        return root.keys().streamable(SPLITERATOR_CHARACTERISTICS);
    }

    @Nonnull
    @Override
    public IterableStreamable values()
    {
        return root.values().streamable(SPLITERATOR_CHARACTERISTICS);
    }

    @Override
    public int getSpliteratorCharacteristics()
    {
        return SPLITERATOR_CHARACTERISTICS;
    }

    @Override
    public void forEach(Consumer> action)
    {
        forEach((i, v) -> action.accept(entry(i, v)));
    }

    @Override
    public  void forEachThrows(@Nonnull Proc1Throws, E> proc)
        throws E
    {
        forEachThrows((i, v) -> proc.apply(entry(i, v)));
    }

    @Override
    public void forEach(@Nonnull IndexedProc1 proc)
    {
        root.forEach(proc);
    }

    @Override
    public  void forEachThrows(@Nonnull IndexedProc1Throws proc)
        throws E
    {
        root.forEachThrows(proc);
    }

    @SuppressWarnings("rawtypes")
    @Override
    public boolean equals(Object o)
    {
        return (o == this) || ((o instanceof JImmutableArray) && IteratorHelper.iteratorEquals(iterator(), ((JImmutableArray)o).iterator()));
    }

    @Override
    public int hashCode()
    {
        return IteratorHelper.iteratorHashCode(iterator());
    }

    @Override
    public String toString()
    {
        return IteratorHelper.iteratorToString(iterator());
    }

    @Nonnull
    @Override
    public JImmutableArray.Builder arrayBuilder()
    {
        return new Builder<>();
    }

    private Object writeReplace()
    {
        return new JImmutableArrayProxy(this);
    }

    @ThreadSafe
    public static class Builder
        implements JImmutableArray.Builder
    {
        private final TrieArrayBuilder builder;

        private Builder()
        {
            builder = new TrieArrayBuilder<>();
        }

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

        @Nonnull
        @Override
        public synchronized JImmutableArray.Builder clear()
        {
            builder.reset();
            return this;
        }

        @Nonnull
        @Override
        public synchronized JImmutableArray.Builder add(T value)
        {
            builder.add(value);
            return this;
        }

        @Nonnull
        @Override
        public synchronized JImmutableArray.Builder put(int index,
                                                           T value)
        {
            builder.put(index, value);
            return this;
        }

        @Override
        public synchronized JImmutableArray.Builder setNextIndex(int index)
        {
            builder.setNextIndex(index);
            return this;
        }

        @Nonnull
        @Override
        public synchronized JImmutableArray build()
        {
            return builder.size() == 0 ? of() : new JImmutableTrieArray<>(builder.buildRoot());
        }

        @Nonnull
        private synchronized Iterator iterator()
        {
            return TransformIterator.of(builder.iterator(), JImmutableMap.Entry::getValue);
        }
    }
}