Package org.apache.creadur.whisker.out.velocity

Enum Product

java.lang.Object

java.lang.Enum<Product>

org.apache.creadur.whisker.out.velocity.Product

All Implemented Interfaces:

Serializable, Comparable<Product>, java.lang.constant.Constable

public enum Product
extends Enum<Product>

Products generated by velocity templates.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRECTORIES_REPORT_TEMPLATE	Produces a directories report.
LICENSE	Produces a LICENSE report.
MISSING_LICENSE_REPORT_TEMPLATE	Produces a missing license report.
NOTICE	Produces a NOTICE report.
XML_TEMPLATE	Produces an xml template.

Method Summary

Modifier and Type	Method	Description
Result	getResult()	Gets result implemented by this product.
String	getTemplate()	Gets the template name that generates this product.
static Product	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Product[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
Writer	writerFrom(ResultWriterFactory writerFactory)	Builds writer for this product.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOTICE

public static final Product NOTICE

Produces a NOTICE report.

LICENSE

public static final Product LICENSE

Produces a LICENSE report.

DIRECTORIES_REPORT_TEMPLATE

public static final Product DIRECTORIES_REPORT_TEMPLATE

Produces a directories report.

MISSING_LICENSE_REPORT_TEMPLATE

public static final Product MISSING_LICENSE_REPORT_TEMPLATE

Produces a missing license report.

XML_TEMPLATE

public static final Product XML_TEMPLATE

Produces an xml template.

Method Details

values

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

getTemplate

public String getTemplate()

Gets the template name that generates this product.

Returns:

not null

getResult

public Result getResult()

Gets result implemented by this product.

Returns:

not null

writerFrom

public Writer writerFrom(ResultWriterFactory writerFactory)
                  throws IOException

Builds writer for this product.

Parameters:

writerFactory - not null

Returns:

not null

Throws:

IOException - when write fails