Package org.jacoco.maven

Class 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.reporting.AbstractMavenReport
    Base class for creating a code coverage report for tests of a single project in multiple formats (HTML, XML, and CSV).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) java.util.List<java.lang.String> excludes
      A list of class files to exclude from the report.
      (package private) java.lang.String footer
      Footer text used in HTML report pages.
      (package private) java.util.List<java.lang.String> includes
      A list of class files to include in the report.
      (package private) java.lang.String outputEncoding
      Encoding of the generated reports.
      (package private) org.apache.maven.project.MavenProject project
      Maven project.
      (package private) org.apache.maven.doxia.siterenderer.Renderer siteRenderer
      Doxia Site Renderer.
      (package private) boolean skip
      Flag used to suppress execution.
      (package private) java.lang.String sourceEncoding
      Encoding of the source files.
      (package private) java.lang.String title
      Name of the root node HTML report pages.

      • Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

        outputDirectory

      • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) abstract void addFormatters​(ReportSupport support, java.util.Locale locale)  
      boolean canGenerateReport()  
      (package private) abstract boolean canGenerateReportRegardingClassesDirectory()  
      (package private) abstract boolean canGenerateReportRegardingDataFiles()  
      (package private) abstract void createReport​(IReportGroupVisitor visitor, ReportSupport support)  
      void execute()
      This method is called when the report generation is invoked directly as a standalone Mojo.
      protected void executeReport​(java.util.Locale locale)  
      java.lang.String getDescription​(java.util.Locale locale)  
      (package private) java.util.List<java.lang.String> getExcludes()
      Returns the list of class files to exclude from the report.
      (package private) java.util.List<java.lang.String> getIncludes()
      Returns the list of class files to include in the report.
      protected org.apache.maven.project.MavenProject getProject()  
      protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()  
      boolean isExternalReport()  
      (package private) abstract void loadExecutionData​(ReportSupport support)  

      • Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

        closeReport, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory

      • 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

    • Field Detail

      • outputEncoding

        @Parameter(property="project.reporting.outputEncoding",
           defaultValue="UTF-8")
java.lang.String outputEncoding
        Encoding of the generated reports.

      • title

        @Parameter(defaultValue="${project.name}")
java.lang.String title
        Name of the root node HTML report pages.
        Since:
        0.7.7

      • footer

        @Parameter
java.lang.String footer
        Footer text used in HTML report pages.
        Since:
        0.7.7

      • sourceEncoding

        @Parameter(property="project.build.sourceEncoding",
           defaultValue="UTF-8")
java.lang.String sourceEncoding
        Encoding of the source files.

      • includes

        @Parameter
java.util.List<java.lang.String> includes
        A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.

      • excludes

        @Parameter
java.util.List<java.lang.String> excludes
        A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.

      • skip

        @Parameter(property="jacoco.skip",
           defaultValue="false")
boolean skip
        Flag used to suppress execution.

      • project

        @Parameter(property="project",
           readonly=true)
org.apache.maven.project.MavenProject project
        Maven project.

      • siteRenderer

        @Component
org.apache.maven.doxia.siterenderer.Renderer siteRenderer
        Doxia Site Renderer.

    • Constructor Detail

      • AbstractReportMojo

        public AbstractReportMojo()

    • Method Detail

      • getDescription

        public java.lang.String getDescription​(java.util.Locale locale)

      • isExternalReport

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

      • getProject

        protected org.apache.maven.project.MavenProject getProject()
        Overrides:
        getProject in class org.apache.maven.reporting.AbstractMavenReport

      • getSiteRenderer

        protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
        Overrides:
        getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

      • getIncludes

        java.util.List<java.lang.String> getIncludes()
        Returns the list of class files to include in the report.
        Returns:
        class files to include, may contain wildcard characters

      • getExcludes

        java.util.List<java.lang.String> getExcludes()
        Returns the list of class files to exclude from the report.
        Returns:
        class files to exclude, may contain wildcard characters

      • canGenerateReport

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

      • canGenerateReportRegardingDataFiles

        abstract boolean canGenerateReportRegardingDataFiles()

      • canGenerateReportRegardingClassesDirectory

        abstract boolean canGenerateReportRegardingClassesDirectory()

      • 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
        Overrides:
        execute in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • executeReport

        protected void executeReport​(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
        Specified by:
        executeReport in class org.apache.maven.reporting.AbstractMavenReport
        Throws:
        org.apache.maven.reporting.MavenReportException

      • loadExecutionData

        abstract void loadExecutionData​(ReportSupport support)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • addFormatters

        abstract void addFormatters​(ReportSupport support,
                            java.util.Locale locale)
                     throws java.io.IOException
        Throws:
        java.io.IOException