Package org.apache.rat.report
Interface RatReport
- All Known Implementing Classes:
AbstractClaimReporter
,AbstractReport
,ClaimAggregator
,ClaimReporterMultiplexer
,LicenseAddingReport
,SimpleXmlClaimReporter
public interface RatReport
Interface that defines a RatReport.
A RatReport examines a document and may report issues or modify the underlying file.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Signals the end of execution for the report.void
Performs the actual reporting on the given document.void
Signals the start of execution for the report.
-
Method Details
-
startReport
Signals the start of execution for the report. Will be called before thereport()
method to ensure proper setup.- Throws:
RatException
- on error.- See Also:
report(Document)
-
report
Performs the actual reporting on the given document.- Parameters:
document
- write any reporting results into this document upon analysis.- Throws:
RatException
- on error.
-
endReport
Signals the end of execution for the report. Will be called after thereport()
method to ensure proper cleanup.- Throws:
RatException
- on error.- See Also:
report(Document)
-