com.credibledoc.substitution.doc.template

Enum Template

java.lang.Object

java.lang.Enum<Template>

com.credibledoc.substitution.doc.template.Template

All Implemented Interfaces:

Serializable, Comparable<Template>

public enum Template
extends Enum<Template>

Type of template file, contains a templateRelativePath field

Author:

Kyrylo Semenko

Enum Constant Summary

Enum Constants

Enum Constant and Description
CSS HTML styles
END_UML_DIV End of Plant UML
JAVASCRIPT js/script.js
JQUERY js/jquery-1.11.0.min.js
SEQUENCE_DIAGRAM_FOOTER A footer of plain text template
SEQUENCE_DIAGRAM_HEADER A header of plain text template
SOURCE_LOG_HEADER A header of source file escaped as html

Field Summary

Fields

Modifier and Type	Field and Description
private String	templateRelativePath A path in a classpath, for example "/html/template/sourceLog.html"

Method Summary

Modifier and Type	Method and Description
String	getTemplateRelativePath()
static Template	valueOf(String name) Returns the enum constant of this type with the specified name.
static Template[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CSS

public static final Template CSS

HTML styles

JQUERY

public static final Template JQUERY

js/jquery-1.11.0.min.js

JAVASCRIPT

public static final Template JAVASCRIPT

js/script.js

END_UML_DIV

public static final Template END_UML_DIV

End of Plant UML

SEQUENCE_DIAGRAM_HEADER

public static final Template SEQUENCE_DIAGRAM_HEADER

A header of plain text template

SEQUENCE_DIAGRAM_FOOTER

public static final Template SEQUENCE_DIAGRAM_FOOTER

A footer of plain text template

SOURCE_LOG_HEADER

public static final Template SOURCE_LOG_HEADER

A header of source file escaped as html

Field Detail

templateRelativePath

private final String templateRelativePath

A path in a classpath, for example "/html/template/sourceLog.html"

Method Detail

values

public static Template[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Template c : Template.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Template valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getTemplateRelativePath

public String getTemplateRelativePath()

Returns:

The templateRelativePath field