Package org.jacoco.maven

Class AbstractReportMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.jacoco.maven.AbstractReportMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
ReportAggregateMojo, ReportITMojo, ReportMojo
public abstract class AbstractReportMojo extends org.apache.maven.plugin.AbstractMojo implements org.apache.maven.reporting.MavenMultiPageReport
Base class for creating a code coverage report for tests of a single project in multiple formats (HTML, XML, and CSV).

  • Field Summary

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractReportMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    void
    execute()
    This method is called when the report generation is invoked directly as a standalone Mojo.
    void
    generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale)
     
    void
    generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
     
    String
    getCategoryName()
     
    String
    getDescription(Locale locale)
     
    boolean
    isExternalReport()
     

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.maven.reporting.MavenReport

    getName, getOutputName, getReportOutputDirectory, setReportOutputDirectory

  • Constructor Details

    • AbstractReportMojo

      public AbstractReportMojo()

  • Method Details

    • getDescription

      public String getDescription(Locale locale)
      Specified by:
      getDescription in interface org.apache.maven.reporting.MavenReport

    • isExternalReport

      public boolean isExternalReport()
      Specified by:
      isExternalReport in interface org.apache.maven.reporting.MavenReport

    • getCategoryName

      public String getCategoryName()
      Specified by:
      getCategoryName in interface org.apache.maven.reporting.MavenReport

    • canGenerateReport

      public boolean canGenerateReport()
      Specified by:
      canGenerateReport in interface org.apache.maven.reporting.MavenReport

    • generate

      public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException
      Specified by:
      generate in interface org.apache.maven.reporting.MavenReport
      Throws:
      org.apache.maven.reporting.MavenReportException

    • generate

      public void generate(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale) throws org.apache.maven.reporting.MavenReportException
      Specified by:
      generate in interface org.apache.maven.reporting.MavenMultiPageReport
      Throws:
      org.apache.maven.reporting.MavenReportException

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException
      This method is called when the report generation is invoked directly as a standalone Mojo.
      Specified by:
      execute in interface org.apache.maven.plugin.Mojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException