Package io.github.crizzis.codenarc.report

Enum ReportElements

java.lang.Object

java.lang.Enum<ReportElements>

io.github.crizzis.codenarc.report.ReportElements

All Implemented Interfaces:

Serializable, Comparable<ReportElements>

public enum ReportElements
extends Enum<ReportElements>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DESCRIPTION
FILES_LINE_HEADER
FILES_PRIORITY_HEADER
FILES_RULE_NAME_HEADER
FILES_SOURCE_DIRECTORY_CAPTION
FILES_SOURCE_LINE_MESSAGE_HEADER
FILES_TITLE
GENERAL_INFO_SECTION_TITLE
GENERATION_TIME
PACKAGE_SUMMARY_FILES_WITH_VIOLATIONS_HEADER
PACKAGE_SUMMARY_PACKAGE_HEADER
PACKAGE_SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER
PACKAGE_SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER
PACKAGE_SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER
PACKAGE_SUMMARY_SOURCE_DIRECTORY_CAPTION
PACKAGE_SUMMARY_TITLE
PACKAGE_SUMMARY_TOTAL_VIOLATION_HEADER
SUMMARY_FILES_WITH_VIOLATIONS_HEADER
SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER
SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER
SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER
SUMMARY_SECTION_TITLE
SUMMARY_TOTAL_FILES_HEADER
SUMMARY_TOTAL_VIOLATIONS_HEADER
TITLE
VERSION_CAPTION

Method Summary

Modifier and Type	Method	Description
String	path()
static ReportElements	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReportElements[]	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

TITLE

public static final ReportElements TITLE

GENERAL_INFO_SECTION_TITLE

public static final ReportElements GENERAL_INFO_SECTION_TITLE

DESCRIPTION

public static final ReportElements DESCRIPTION

VERSION_CAPTION

public static final ReportElements VERSION_CAPTION

GENERATION_TIME

public static final ReportElements GENERATION_TIME

SUMMARY_SECTION_TITLE

public static final ReportElements SUMMARY_SECTION_TITLE

SUMMARY_TOTAL_FILES_HEADER

public static final ReportElements SUMMARY_TOTAL_FILES_HEADER

SUMMARY_FILES_WITH_VIOLATIONS_HEADER

public static final ReportElements SUMMARY_FILES_WITH_VIOLATIONS_HEADER

SUMMARY_TOTAL_VIOLATIONS_HEADER

public static final ReportElements SUMMARY_TOTAL_VIOLATIONS_HEADER

SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER

public static final ReportElements SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER

SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER

public static final ReportElements SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER

SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER

public static final ReportElements SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER

PACKAGE_SUMMARY_TITLE

public static final ReportElements PACKAGE_SUMMARY_TITLE

PACKAGE_SUMMARY_SOURCE_DIRECTORY_CAPTION

public static final ReportElements PACKAGE_SUMMARY_SOURCE_DIRECTORY_CAPTION

PACKAGE_SUMMARY_PACKAGE_HEADER

public static final ReportElements PACKAGE_SUMMARY_PACKAGE_HEADER

PACKAGE_SUMMARY_FILES_WITH_VIOLATIONS_HEADER

public static final ReportElements PACKAGE_SUMMARY_FILES_WITH_VIOLATIONS_HEADER

PACKAGE_SUMMARY_TOTAL_VIOLATION_HEADER

public static final ReportElements PACKAGE_SUMMARY_TOTAL_VIOLATION_HEADER

PACKAGE_SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER

public static final ReportElements PACKAGE_SUMMARY_PRIORITY_ONE_VIOLATIONS_HEADER

PACKAGE_SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER

public static final ReportElements PACKAGE_SUMMARY_PRIORITY_TWO_VIOLATIONS_HEADER

PACKAGE_SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER

public static final ReportElements PACKAGE_SUMMARY_PRIORITY_THREE_VIOLATIONS_HEADER

FILES_TITLE

public static final ReportElements FILES_TITLE

FILES_SOURCE_DIRECTORY_CAPTION

public static final ReportElements FILES_SOURCE_DIRECTORY_CAPTION

FILES_RULE_NAME_HEADER

public static final ReportElements FILES_RULE_NAME_HEADER

FILES_PRIORITY_HEADER

public static final ReportElements FILES_PRIORITY_HEADER

FILES_LINE_HEADER

public static final ReportElements FILES_LINE_HEADER

FILES_SOURCE_LINE_MESSAGE_HEADER

public static final ReportElements FILES_SOURCE_LINE_MESSAGE_HEADER

Method Detail

values

public static ReportElements[] 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 (ReportElements c : ReportElements.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReportElements 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

path

public String path()