001package com.credibledoc.substitution.doc.template;
002
003/**
004 * Type of template file, contains a {@link #templateRelativePath} field
005 * @author Kyrylo Semenko
006 */
007public enum Template {
008
009    /** HTML styles */
010    CSS("/template/css/css.css"),
011
012    /** js/jquery-1.11.0.min.js */
013    JQUERY("/template/js/jquery-1.11.0.min.js"),
014
015    /** js/script.js */
016    JAVASCRIPT("/template/js/script.js"),
017
018    /** End of Plant UML */
019    END_UML_DIV("/template/endUmlDiv.html"),
020
021    /** A header of plain text template */
022    SEQUENCE_DIAGRAM_HEADER("/template/sequenceDiagramHeader.html"),
023
024    /** A footer of plain text template */
025    SEQUENCE_DIAGRAM_FOOTER("/template/sequenceDiagramFooter.html"),
026
027    /** A header of source file escaped as html */
028    SOURCE_LOG_HEADER("/template/sourceLogHeader.html");
029
030    /** A path in a classpath, for example "/html/template/sourceLog.html" */
031    private final String templateRelativePath;
032
033    /**
034     * Constructor to set {@link #templateRelativePath}
035     * @param templateRelativePath see {@link #templateRelativePath} field
036     */
037    Template(String templateRelativePath) {
038        this.templateRelativePath = templateRelativePath;
039    }
040
041    /**
042     * @return The {@link Template#templateRelativePath} field
043     */
044    public String getTemplateRelativePath() {
045        return templateRelativePath;
046    }
047
048}