com.swirlds.common.merkle.route.internal.AbstractMerkleRoute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2016-2024 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.swirlds.common.merkle.route.internal;

import com.swirlds.common.merkle.route.MerkleRoute;
import java.util.Iterator;

public abstract class AbstractMerkleRoute implements MerkleRoute {

    /**
     * {@inheritDoc}
     */
    @Override
    public final int compareTo(final MerkleRoute that) {
        final Iterator iteratorA = this.iterator();
        final Iterator iteratorB = that.iterator();

        while (iteratorA.hasNext() && iteratorB.hasNext()) {
            final int a = iteratorA.next();
            final int b = iteratorB.next();
            if (a < b) {
                return -1;
            } else if (b < a) {
                return 1;
            }
        }

        // No differences found
        return 0;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean isAncestorOf(final MerkleRoute that) {
        Iterator iteratorA = this.iterator();
        Iterator iteratorB = that.iterator();

        while (iteratorA.hasNext() && iteratorB.hasNext()) {
            final int a = iteratorA.next();
            final int b = iteratorB.next();

            if (a != b) {
                return false;
            }
        }

        return !iteratorA.hasNext();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean isDescendantOf(final MerkleRoute that) {
        return that.isAncestorOf(this);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final String toString() {
        final Iterator iterator = iterator();

        StringBuilder sb = new StringBuilder();
        sb.append("[");

        iterator.forEachRemaining((Integer step) -> {
            sb.append(step);
            if (iterator.hasNext()) {
                sb.append(" -> ");
            }
        });

        sb.append("]");
        return sb.toString();
    }
}