com.swirlds.common.merkle.MerkleNode 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;

import com.swirlds.common.FastCopyable;
import com.swirlds.common.Reservable;
import com.swirlds.common.crypto.Hashable;
import com.swirlds.common.io.SerializableDet;
import com.swirlds.common.merkle.interfaces.MerkleMigratable;
import com.swirlds.common.merkle.interfaces.MerkleTraversable;
import com.swirlds.common.merkle.iterators.MerkleIterator;
import com.swirlds.common.merkle.route.MerkleRoute;
import com.swirlds.common.merkle.route.MerkleRouteIterator;
import com.swirlds.common.merkle.synchronization.views.MaybeCustomReconnectRoot;

/**
 * A MerkleNode object has the following properties
 * 
 *     Doesn't need to compute its hash
 *     It's not aware of Cryptographic Modules
 *     Doesn't need to perform rsync
 *     Doesn't need to provide hints to the Crypto Module
 * 
 */
public interface MerkleNode
        extends FastCopyable,
                Hashable,
                MerkleMigratable,
                MerkleTraversable,
                MaybeCustomReconnectRoot,
                Reservable,
                SerializableDet {

    /**
     * {@inheritDoc}
     */
    @SuppressWarnings("unchecked")
    @Override
    MerkleNode copy();

    /**
     * {@inheritDoc}
     */
    @Override
    default MerkleNode migrate(final int version) {
        return this;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default MerkleNode getNodeAtRoute(final MerkleRoute route) {
        return new MerkleRouteIterator(this, route).getLast();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default  MerkleIterator treeIterator() {
        return new MerkleIterator<>(this);
    }
}