001package com.credibledoc.substitution.doc.plantuml;
002
003import com.credibledoc.substitution.core.resource.ResourceService;
004import com.credibledoc.substitution.doc.SubstitutionDocMain;
005
006/**
007 * PlantUML participants, for example {@link #SUBSTITUTION_DOC}.
008 * @author Kyrylo Semenko
009 */
010public enum Participant {
011
012    /**
013     * The substitution module.
014     */
015    SUBSTITUTION_CORE("\"" + ResourceService.SUBSTITUTION_CORE_MODULE_NAME + "\""),
016
017    /**
018     * This module.
019     */
020    SUBSTITUTION_DOC("\"" + SubstitutionDocMain.SUBSTITUTION_DOC + "\"");
021
022    /** A name in a diagram */
023    private final String uml;
024    
025    /**
026     * @param uml see {@link #uml}
027     */
028    Participant(String uml) {
029        this.uml = uml;
030    }
031
032    /**
033     * @return The {@link Participant#uml} field
034     */
035    public String getUml() {
036        return uml;
037    }
038
039}