Package org.apache.rat.report

Class ConfigurationReport

java.lang.Object

org.apache.rat.report.ConfigurationReport

All Implemented Interfaces:

RatReport

public class ConfigurationReport
extends Object
implements RatReport

A report that dumps the ReportConfiguration into the XML output.

Constructor Summary

Constructors

Constructor	Description
ConfigurationReport(IXmlWriter writer, ReportConfiguration configuration)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	startReport()	Signals the start of execution for the report.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.rat.report.RatReport

endReport, report

Constructor Details

ConfigurationReport

public ConfigurationReport(IXmlWriter writer,
 ReportConfiguration configuration)

Constructor.

Parameters:

writer - The writer to write the XML data to.

configuration - the configuration to dump

Method Details

startReport

public void startReport()
                 throws RatException

Description copied from interface: RatReport

Signals the start of execution for the report. Will be called before the report() method to ensure proper setup. Default implementation does nothing.

Specified by:

startReport in interface RatReport

Throws:

RatException - on error.

See Also:

RatReport.report(Document)