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

Class VelocityReports

java.lang.Object

org.apache.creadur.whisker.out.velocity.VelocityReports

public class VelocityReports
extends Object

Wraps velocity engine.

Constructor Summary

Constructors

Constructor	Description
VelocityReports(ResultWriterFactory writerFactory)	Constructs a reporter using Apache Velocity.

Method Summary

Modifier and Type	Method	Description
final void	generate(Descriptor work, Configuration configuration)	Reports on work.
final void	generateTemplate(Collection<Directory> withBase)	Generates template.
final void	report(Collection<Directory> directories)	Generates a directory report.
final void	validate(LicenseAnalyst analyst)	Reports on analysis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VelocityReports

public VelocityReports(ResultWriterFactory writerFactory)

Constructs a reporter using Apache Velocity.

Parameters:

writerFactory - not null

Method Details

generate

public final void generate(Descriptor work,
 Configuration configuration)
                    throws Exception

Reports on work.

Parameters:

work - not null

configuration - not null

Throws:

Exception - when generation fails

report

public final void report(Collection<Directory> directories)
                  throws Exception

Generates a directory report.

Parameters:

directories - not null

Throws:

Exception - when reporting fails

validate

public final void validate(LicenseAnalyst analyst)
                    throws Exception

Reports on analysis.

Parameters:

analyst - not null

Throws:

Exception - when validation fails

generateTemplate

public final void generateTemplate(Collection<Directory> withBase)
                            throws Exception

Generates template.

Parameters:

withBase - not null

Throws:

Exception - when generation fails