com.swirlds.common.merkle.synchronization.task.InternalDataLesson 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.synchronization.task;

import com.swirlds.common.crypto.Hash;
import com.swirlds.common.io.SelfSerializable;
import com.swirlds.common.io.streams.SerializableDataInputStream;
import com.swirlds.common.io.streams.SerializableDataOutputStream;
import com.swirlds.common.merkle.MerkleInternal;
import com.swirlds.common.merkle.synchronization.views.LearnerTreeView;
import com.swirlds.common.merkle.synchronization.views.TeacherTreeView;
import java.io.IOException;
import java.util.List;

/**
 * This lesson contains data for an internal node.
 *
 * @param 
 * 		the type used by the view to represent a merkle node
 */
public class InternalDataLesson implements SelfSerializable {

    private static final long CLASS_ID = 0xb76e98a8989c60a1L;

    private static final class ClassVersion {
        public static final int ORIGINAL = 1;
    }

    private TeacherTreeView teacherTreeView;
    private LearnerTreeView learnerTreeView;
    private T internal;
    private List queries;

    /**
     * Zero arg constructor for constructable registry.
     */
    public InternalDataLesson() {}

    /**
     * Create a new lesson containing an internal node.
     *
     * @param teacherTreeView
     * 		the teacher's view
     * @param internal
     * 		the internal node to include in the lesson
     */
    public InternalDataLesson(final TeacherTreeView teacherTreeView, final T internal) {
        this.teacherTreeView = teacherTreeView;
        this.internal = internal;
    }

    /**
     * Create a new object that will be used to deserialize the lesson.
     *
     * @param learnerTreeView
     * 		the learner's view
     */
    public InternalDataLesson(final LearnerTreeView learnerTreeView) {
        this.learnerTreeView = learnerTreeView;
    }

    /**
     * Get the internal node described by the lesson.
     *
     * @return the node described by the lesson
     */
    public T getInternal() {
        return internal;
    }

    /**
     * Get the queries contained by this lesson (i.e. the hashes of the children of the internal node).
     *
     * @return a list of queries
     */
    public List getQueries() {
        return queries;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long getClassId() {
        return CLASS_ID;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void serialize(final SerializableDataOutputStream out) throws IOException {
        teacherTreeView.serializeInternal(out, internal);
        teacherTreeView.writeChildHashes(internal, out);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void deserialize(final SerializableDataInputStream in, final int version) throws IOException {
        internal = learnerTreeView.deserializeInternal(in);
        queries = in.readSerializableList(MerkleInternal.MAX_CHILD_COUNT_UBOUND, false, Hash::new);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getVersion() {
        return ClassVersion.ORIGINAL;
    }
}