org.javimmutable.collections.tree.AbstractNode Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// 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.tree;

import org.javimmutable.collections.Func1;
import org.javimmutable.collections.Holder;
import org.javimmutable.collections.JImmutableMap.Entry;
import org.javimmutable.collections.Proc2;
import org.javimmutable.collections.Proc2Throws;
import org.javimmutable.collections.SplitableIterable;
import org.javimmutable.collections.Sum2;
import org.javimmutable.collections.Sum2Throws;
import org.javimmutable.collections.common.CollisionMap;
import org.javimmutable.collections.common.CollisionSet;
import org.javimmutable.collections.common.ToStringHelper;
import org.javimmutable.collections.iterators.GenericIterator;
import org.javimmutable.collections.iterators.IteratorHelper;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Comparator;

abstract class AbstractNode
    implements SplitableIterable>,
               GenericIterator.Iterable>,
               CollisionMap.Node,
               CollisionSet.Node
{
    abstract boolean containsKey(@Nonnull Comparator comp,
                                 @Nonnull K key);

    abstract V get(@Nonnull Comparator comp,
                   @Nonnull K key,
                   V defaultValue);

    @Nonnull
    abstract Holder find(@Nonnull Comparator comp,
                            @Nonnull K key);

    @Nonnull
    abstract Holder> findEntry(@Nonnull Comparator comp,
                                           @Nonnull K key);

    abstract boolean isEmpty();

    abstract int size();

    @Nonnull
    abstract AbstractNode assign(@Nonnull Comparator comp,
                                       @Nonnull K key,
                                       @Nullable V value);

    @Nonnull
    abstract AbstractNode delete(@Nonnull Comparator comp,
                                       @Nonnull K key);

    @Nonnull
    abstract AbstractNode update(@Nonnull Comparator comp,
                                       @Nonnull K key,
                                       @Nonnull Func1, V> generator);

    @Nonnull
    abstract DeleteResult deleteLeftmost();

    @Nonnull
    abstract DeleteResult deleteRightmost();

    abstract int depth();

    @Nonnull
    abstract K key();

    @Nullable
    abstract V value();

    @Nonnull
    abstract AbstractNode left();

    @Nonnull
    abstract AbstractNode right();

    abstract void checkInvariants(@Nonnull Comparator comp);

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

    @Override
    public boolean equals(Object obj)
    {
        return (obj instanceof AbstractNode) && IteratorHelper.iteratorEquals(iterator(), ((AbstractNode)obj).iterator());
    }

    abstract void forEach(@Nonnull Proc2 proc);

    abstract  void forEachThrows(@Nonnull Proc2Throws proc)
        throws E;

    abstract  R reduce(R sum,
                          @Nonnull Sum2 proc);

    abstract  R reduceThrows(R sum,
                                                     @Nonnull Sum2Throws proc)
        throws E;

    @Override
    public String toString()
    {
        final StringBuilder sb = new StringBuilder();
        sb.append("[");
        forEach((key, value) -> ToStringHelper.addToString(sb, 1, key, value));
        sb.append("]");
        return sb.toString();
    }

    static class DeleteResult
    {
        final K key;
        final V value;
        final AbstractNode remainder;

        DeleteResult(@Nonnull K key,
                     V value,
                     @Nonnull AbstractNode remainder)
        {
            this.key = key;
            this.value = value;
            this.remainder = remainder;
        }

        @Nonnull
        DeleteResult withRemainder(@Nonnull AbstractNode remainder)
        {
            return new DeleteResult<>(key, value, remainder);
        }
    }
}