com.swirlds.common.crypto.SerializableHashable 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.crypto;

import com.swirlds.common.io.SelfSerializable;

public interface SerializableHashable extends Hashable, SelfSerializable {
    /**
     * Should return a hash of the object if it has been calculated. If the method returns null, an external utility
     * will serialize the object, including its class ID and version, and set its hash by calling
     * {@link #setHash(Hash)}.
     * 
     * If the class wants to implement its own hashing, this method should never return null. The class should
     * calculate its own hash, which should include the class ID and version, and return that hash by this method.
     *
     * @return the hash of the object.
     */
    @Override
    Hash getHash();

    /**
     * {@inheritDoc}
     */
    @Override
    void setHash(Hash hash);
}