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

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2018, 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.Cursorable;
import org.javimmutable.collections.Func1;
import org.javimmutable.collections.Holder;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.SplitableIterable;
import org.javimmutable.collections.Tuple2;

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

public interface Node
    extends Cursorable>,
            SplitableIterable>
{
    int MIN_CHILDREN = 16;
    int MAX_CHILDREN = 2 * MIN_CHILDREN;

    @Nullable
    K baseKey();

    /**
     * @return number of direct children of this node
     */
    int childCount();

    /**
     * @return number of values of descendants of this node
     */
    int valueCount();

    V getValueOr(@Nonnull Comparator comparator,
                 @Nonnull K key,
                 V defaultValue);

    @Nonnull
    Holder find(@Nonnull Comparator comparator,
                   @Nonnull K key);

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

    @Nonnull
    UpdateResult assign(@Nonnull Comparator comparator,
                              @Nonnull K key,
                              V value);

    @Nonnull
    UpdateResult update(@Nonnull Comparator comparator,
                              @Nonnull K key,
                              @Nonnull Func1, V> generator);

    @Nonnull
    Node delete(@Nonnull Comparator comparator,
                      @Nonnull K key);

    @Nonnull
    Node mergeChildren(@Nonnull Node sibling);

    @Nonnull
    Tuple2, Node> distributeChildren(@Nonnull Node sibling);

    @Nonnull
    Node compress();

    int depth();

    default boolean isEmpty()
    {
        return false;
    }

    void checkInvariants(@Nonnull Comparator comparator);
}