com.credibledoc.substitution.doc.plantuml.Participant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of substitution-doc Show documentation

This module generates a documentation for the https://github.com/credibledoc/credible-doc/tree/master/substitution projects. See description on the https://github.com/credibledoc/credible-doc/tree/master/substitution/substitution-doc page.

There is a newer version: 1.0.8

Show newest version

package com.credibledoc.substitution.doc.plantuml;

import com.credibledoc.substitution.core.resource.ResourceService;
import com.credibledoc.substitution.doc.SubstitutionDocMain;

/**
 * PlantUML participants, for example {@link #SUBSTITUTION_DOC}.
 * @author Kyrylo Semenko
 */
public enum Participant {

    /**
     * The placeholder-substitution module.
     */
    SUBSTITUTION_CORE("\"" + ResourceService.SUBSTITUTION_CORE_MODULE_NAME + "\""),

    /**
     * This module.
     */
    SUBSTITUTION_DOC("\"" + SubstitutionDocMain.SUBSTITUTION_DOC + "\"");

    /** A name in a diagram */
    private final String uml;
    
    /**
     * @param uml see {@link #uml}
     */
    Participant(String uml) {
        this.uml = uml;
    }

    /**
     * @return The {@link Participant#uml} field
     */
    public String getUml() {
        return uml;
    }

}