com.swirlds.common.wiring.model.internal.analysis.MermaidNameShortener 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) 2023-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.wiring.model.internal.analysis;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.HashMap;
import java.util.Map;

/**
 * Generates shortened names in a mermaid wiring flowchart. Reduces the resulting flowchart size.
 */
public class MermaidNameShortener {

    private final Map vertexNameMap = new HashMap<>();

    /**
     * Get the name that should be used for a vertex with the given base name.
     *
     * @param baseName the base name of the vertex
     * @return the name that should be used for a vertex with the given base name
     */
    @NonNull
    public String getShortVertexName(@NonNull final String baseName) {
        return vertexNameMap.computeIfAbsent(baseName, this::generateShortVertexName);
    }

    /**
     * Generate a name for a vertex with the given base name.
     *
     * @param baseName the base name of the vertex
     * @return the name that should be used for a vertex with the given base name
     */
    @NonNull
    private String generateShortVertexName(@NonNull final String baseName) {
        return "v" + vertexNameMap.size();
    }
}