Package org.apache.rat.report.claim

Class ClaimReporterMultiplexer

java.lang.Object

org.apache.rat.report.claim.ClaimReporterMultiplexer

All Implemented Interfaces:

RatReport

public class ClaimReporterMultiplexer
extends Object
implements RatReport

Executes a RatReport that multiplexes the running of multiple RatReports

Constructor Summary

Constructors

Constructor	Description
ClaimReporterMultiplexer(IXmlWriter writer, boolean dryRun, DocumentAnalyser analyser, List<? extends RatReport> reporters)	A multiplexer to run multiple claim reports.

Method Summary

Modifier and Type	Method	Description
void	endReport()	Signals the end of execution for the report.
void	report(Document document)	Performs the actual reporting on the given document.
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

Constructor Details

ClaimReporterMultiplexer

public ClaimReporterMultiplexer(IXmlWriter writer,
 boolean dryRun,
 DocumentAnalyser analyser,
 List<? extends RatReport> reporters)

A multiplexer to run multiple claim reports.

Parameters:

dryRun - true if this is a dry run.

analyser - the analyser to use.

reporters - the reports to execute.

Method Details

report

public void report(Document document)
            throws RatException

Description copied from interface: RatReport

Performs the actual reporting on the given document. Default implementation does nothing.

Specified by:

report in interface RatReport

Parameters:

document - write any reporting results into this document upon analysis.

Throws:

RatException - on error.

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)

endReport

public void endReport()
               throws RatException

Description copied from interface: RatReport

Signals the end of execution for the report. Will be called after the report() method to ensure proper cleanup. Default implementation does nothing.

Specified by:

endReport in interface RatReport

Throws:

RatException - on error.

See Also:

• RatReport.report(Document)