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

import com.swirlds.common.constructable.ConstructableIgnored;
import com.swirlds.common.crypto.Hash;
import com.swirlds.common.merkle.MerkleInternal;
import com.swirlds.common.merkle.MerkleNode;
import com.swirlds.common.merkle.route.MerkleRoute;

/**
 * Implementing this interface allows for a class to implement the {@link MerkleInternal} interface using inheritance
 * by composition with minimal boilerplate.
 */
@ConstructableIgnored
public interface ComposedMerkleInternal extends MerkleInternal {

    /**
     * Get an object that implements the {@link PartialMerkleInternal} interface.
     * This object will be inherited by composition.
     *
     * @return an object which implements the {@link PartialMerkleInternal} interface.
     */
    PartialMerkleInternal getMerkleImplementation();

    /**
     * {@inheritDoc}
     */
    @Override
    default void setHash(final Hash hash) {
        getMerkleImplementation().setHash(hash);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default int getNumberOfChildren() {
        return getMerkleImplementation().getNumberOfChildren();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default  T getChild(final int index) {
        return getMerkleImplementation().getChild(index);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default void setChild(
            final int index, final MerkleNode child, final MerkleRoute childRoute, final boolean childMayBeImmutable) {

        getMerkleImplementation().setChild(index, child, childRoute, childMayBeImmutable);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default Hash getHash() {
        return getMerkleImplementation().getHash();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default MerkleRoute getRoute() {
        return getMerkleImplementation().getRoute();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default void setRoute(final MerkleRoute route) {
        getMerkleImplementation().setRoute(route);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default void reserve() {
        getMerkleImplementation().reserve();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default boolean tryReserve() {
        return getMerkleImplementation().tryReserve();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default boolean release() {
        return getMerkleImplementation().release();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default boolean isDestroyed() {
        return getMerkleImplementation().isDestroyed();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default int getReservationCount() {
        return getMerkleImplementation().getReservationCount();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default boolean isImmutable() {
        return getMerkleImplementation().isImmutable();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default boolean isLeaf() {
        return getMerkleImplementation().isLeaf();
    }
}