com.swirlds.common.merkle.iterators.internal.MerkleIterationAlgorithm 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) 2018-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.iterators.internal;

import com.swirlds.common.merkle.MerkleInternal;
import com.swirlds.common.merkle.MerkleNode;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.function.ObjIntConsumer;

/**
 * Defines algorithm specific behavior for a merkle iterator.
 */
public interface MerkleIterationAlgorithm {

    /**
     * Push a node into the stack/queue.
     */
    void push(@NonNull MerkleNode node);

    /**
     * Remove and return the next item in the stack/queue.
     */
    @NonNull
    MerkleNode pop();

    /**
     * Return the next item in the stack/queue but do not remove it.
     */
    @NonNull
    MerkleNode peek();

    /**
     * Get the number of elements in the stack/queue.
     */
    int size();

    /**
     * Call pushNode on all of a merkle node's children.
     *
     * @param parent
     * 		the parent with children to push
     * @param pushNode
     * 		a method to be used to push children. First argument is the parent, second argument is the child index.
     */
    void pushChildren(@NonNull final MerkleInternal parent, @NonNull final ObjIntConsumer pushNode);
}