Package org.apache.rat.report.xml

Enum XmlElements.Elements

java.lang.Object

java.lang.Enum<XmlElements.Elements>

org.apache.rat.report.xml.XmlElements.Elements

All Implemented Interfaces:

Serializable, Comparable<XmlElements.Elements>

Enclosing class:

XmlElements

public static enum XmlElements.Elements
extends Enum<XmlElements.Elements>

The elements in the report.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCUMENT_TYPE	A document type entry
LICENSE	A license element
LICENSE_CATEGORY	A license category entry
LICENSE_NAME	A license name entry
NOTES	A notes element
RAT_REPORT	The start of the Rat report
RESOURCE	A resource element
STATISTIC	A statistic entry
STATISTICS	A statistics element
VERSION	The version of Rat being run

Method Summary

Modifier and Type	Method	Description
String	getElementName()	Gets the XML element name.
static XmlElements.Elements	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XmlElements.Elements[]	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 Details

RAT_REPORT

public static final XmlElements.Elements RAT_REPORT

The start of the Rat report

VERSION

public static final XmlElements.Elements VERSION

The version of Rat being run

RESOURCE

public static final XmlElements.Elements RESOURCE

A resource element

LICENSE

public static final XmlElements.Elements LICENSE

A license element

NOTES

public static final XmlElements.Elements NOTES

A notes element

STATISTICS

public static final XmlElements.Elements STATISTICS

A statistics element

STATISTIC

public static final XmlElements.Elements STATISTIC

A statistic entry

LICENSE_NAME

public static final XmlElements.Elements LICENSE_NAME

A license name entry

LICENSE_CATEGORY

public static final XmlElements.Elements LICENSE_CATEGORY

A license category entry

DOCUMENT_TYPE

public static final XmlElements.Elements DOCUMENT_TYPE

A document type entry

Method Details

values

public static XmlElements.Elements[] values()

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

Returns:

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

valueOf

public static XmlElements.Elements 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

getElementName

public String getElementName()

Gets the XML element name.

Returns:

the XML element name.