Package org.apache.rat.commandline

Enum StyleSheets

java.lang.Object

java.lang.Enum<StyleSheets>

org.apache.rat.commandline.StyleSheets

All Implemented Interfaces:

Serializable, Comparable<StyleSheets>

public enum StyleSheets
extends Enum<StyleSheets>

The enumeration of system defined stylesheets.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MISSING_HEADERS	The missing header report style sheet
PLAIN	The plain style sheet.
UNAPPROVED_LICENSES	The unapproved licenses report
XML	The plain style sheet.

Method Summary

Modifier and Type	Method	Description
String	arg()	Gets the name of the xslt file.
String	desc()	Gets the description of the xslt file.
org.apache.commons.io.function.IOSupplier<InputStream>	getStyleSheet()	Gets the IOSupplier for a style sheet.
static org.apache.commons.io.function.IOSupplier<InputStream>	getStyleSheet(String name)	Gets the IOSupplier for a style sheet.
static StyleSheets	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StyleSheets[]	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

PLAIN

public static final StyleSheets PLAIN

The plain style sheet. The current default.

MISSING_HEADERS

public static final StyleSheets MISSING_HEADERS

The missing header report style sheet

UNAPPROVED_LICENSES

public static final StyleSheets UNAPPROVED_LICENSES

The unapproved licenses report

XML

public static final StyleSheets XML

The plain style sheet. The current default.

Method Details

values

public static StyleSheets[] 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 StyleSheets 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

getStyleSheet

public org.apache.commons.io.function.IOSupplier<InputStream> getStyleSheet()

Gets the IOSupplier for a style sheet.

Returns:

an IOSupplier for the sheet.

getStyleSheet

public static org.apache.commons.io.function.IOSupplier<InputStream> getStyleSheet(String name)

Gets the IOSupplier for a style sheet.

Parameters:

name - the short name for or the path to a style sheet.

Returns:

the IOSupplier for the style sheet.

arg

public String arg()

Gets the name of the xslt file.

Returns:

the name of the xslt file, without the extension.

desc

public String desc()

Gets the description of the xslt file.

Returns:

the description of the xslt file.