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

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

@Immutable
public class UpdateResult
{
    public enum Type
    {
        UNCHANGED,
        INPLACE,
        SPLIT
    }

    public final Type type;
    public final TreeNode newNode;
    public final TreeNode extraNode;
    public final int sizeDelta;

    private UpdateResult(Type type,
                         TreeNode newNode,
                         TreeNode extraNode,
                         int sizeDelta)
    {
        this.type = type;
        this.newNode = newNode;
        this.extraNode = extraNode;
        this.sizeDelta = sizeDelta;
    }

    public static  UpdateResult createUnchanged()
    {
        return new UpdateResult(Type.UNCHANGED, null, null, 0);
    }

    public static  UpdateResult createInPlace(TreeNode newNode,
                                                          int sizeDelta)
    {
        return new UpdateResult(Type.INPLACE, newNode, null, sizeDelta);
    }

    public static  UpdateResult createSplit(TreeNode newNode,
                                                        TreeNode extraNode,
                                                        int sizeDelta)
    {
        return new UpdateResult(Type.SPLIT, newNode, extraNode, sizeDelta);
    }

    public TreeNode createTwoNode()
    {
        return new TwoNode(newNode,
                                 extraNode,
                                 newNode.getMaxKey(),
                                 extraNode.getMaxKey());
    }

    public TreeNode createLeftTwoNode(TreeNode right,
                                            K rightMax)
    {
        return new TwoNode(newNode,
                                 right,
                                 newNode.getMaxKey(),
                                 rightMax);
    }

    public TreeNode createLeftThreeNode(TreeNode right,
                                              K rightMax)
    {
        return new ThreeNode(newNode,
                                   extraNode,
                                   right,
                                   newNode.getMaxKey(),
                                   extraNode.getMaxKey(),
                                   rightMax);
    }

    public TreeNode createRightTwoNode(TreeNode left,
                                             K leftMax)
    {
        return new TwoNode(left,
                                 newNode,
                                 leftMax,
                                 newNode.getMaxKey());
    }

    public TreeNode createRightThreeNode(TreeNode left,
                                               K leftMax)
    {
        return new ThreeNode(left,
                                   newNode,
                                   extraNode,
                                   leftMax,
                                   newNode.getMaxKey(),
                                   extraNode.getMaxKey());
    }

    @SuppressWarnings("RedundantIfStatement")
    @Override
    public boolean equals(Object o)
    {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        UpdateResult that = (UpdateResult)o;

        if (sizeDelta != that.sizeDelta) {
            return false;
        }
        if (extraNode != null ? !extraNode.equals(that.extraNode) : that.extraNode != null) {
            return false;
        }
        if (newNode != null ? !newNode.equals(that.newNode) : that.newNode != null) {
            return false;
        }
        if (type != that.type) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode()
    {
        int result = type != null ? type.hashCode() : 0;
        result = 31 * result + (newNode != null ? newNode.hashCode() : 0);
        result = 31 * result + (extraNode != null ? extraNode.hashCode() : 0);
        result = 31 * result + sizeDelta;
        return result;
    }

    @Override
    public String toString()
    {
        return String.format("<%s,%s,%s>", type, newNode, extraNode);
    }
}