com.swirlds.common.constructable.ClassIdFormatter 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.constructable;

import com.swirlds.common.io.SerializableDet;

/**
 * This class provides utility methods for converting class IDs into human readable strings.
 */
public final class ClassIdFormatter {

    private ClassIdFormatter() {}

    /**
     * Convert a class ID to a human readable string in the format "123456789(0x75BCD15)"
     *
     * @param classId
     * 		the class ID to convert to a string
     * @return a formatted string
     */
    public static String classIdString(final long classId) {
        return String.format("%d(0x%X)", classId, classId);
    }

    /**
     * Convert a runtime constructable object to a human readable string in the format
     * "com.swirlds.ClassName:123456789(0x75BCD15)"
     *
     * @param object
     * 		the object to form about
     * @return a formatted string
     */
    public static String classIdString(final RuntimeConstructable object) {
        return String.format("%s:%s", object.getClass().getName(), classIdString(object.getClassId()));
    }

    /**
     * Convert a serializable object to a human readable string in the format
     * "com.swirlds.ClassName:123456789(0x75BCD15)v1"
     *
     * @param object
     * 		the object to form about
     * @return a formatted string
     */
    public static String versionedClassIdString(final SerializableDet object) {
        return String.format(
                "%s:%sv%d", object.getClass().getName(), classIdString(object.getClassId()), object.getVersion());
    }
}