Package org.apache.rat.report

Interface RatReport

All Known Implementing Classes:
AbstractClaimReporter, AbstractReport, ClaimAggregator, ClaimReporterMultiplexer, ClaimValidatorReport, ConfigurationReport, 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 Type
    Method
    Description
    default void
    endReport()
    Signals the end of execution for the report.
    default void
    report​(Document document)
    Performs the actual reporting on the given document.
    default void
    startReport()
    Signals the start of execution for the report.

  • Method Details

    • startReport

      default void startReport() throws RatException
      Signals the start of execution for the report. Will be called before the report() method to ensure proper setup. Default implementation does nothing.
      Throws:
      RatException - on error.
      See Also:
      report(Document)

    • report

      default void report​(Document document) throws RatException
      Performs the actual reporting on the given document. Default implementation does nothing.
      Parameters:
      document - write any reporting results into this document upon analysis.
      Throws:
      RatException - on error.

    • endReport

      default void endReport() throws RatException
      Signals the end of execution for the report. Will be called after the report() method to ensure proper cleanup. Default implementation does nothing.
      Throws:
      RatException - on error.
      See Also:
      report(Document)