Package org.apache.maven.plugins.surefire.report

Class AbstractSurefireReportMojo

  • 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:
    FailsafeReportMojo, SurefireReportMojo
    public abstract class AbstractSurefireReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
    Abstract base class for reporting test results using Surefire.
    Author:
    Stephen Connolly

    • Field Summary

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

        outputDirectory, project, siteRenderer

      • 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
      boolean canGenerateReport()  
      void executeReport​(java.util.Locale locale)
      protected abstract LocalizedProperties getBundle​(java.util.Locale locale, java.lang.ClassLoader resourceBundleClassLoader)  
      protected org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger()  
      abstract java.lang.String getDescription()  
      java.lang.String getDescription​(java.util.Locale locale)
      java.lang.String getName​(java.util.Locale locale)
      abstract java.lang.String getOutputName()
      protected abstract java.io.File getSurefireReportsDirectory​(org.apache.maven.project.MavenProject subProject)
      Gets the default surefire reports directory for the specified project.
      abstract java.lang.String getTitle()  
      protected boolean isGeneratedWhenNoResults()
      Whether the report should be generated when there are no test results.
      protected boolean isSkipped()
      Whether the report should be generated or not.
      abstract void setDescription​(java.lang.String description)  
      abstract void setTitle​(java.lang.String title)  

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

        closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, isExternalReport, 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

    • Constructor Detail

      • AbstractSurefireReportMojo

        public AbstractSurefireReportMojo()

    • Method Detail

      • isSkipped

        protected boolean isSkipped()
        Whether the report should be generated or not.
        Returns:
        true if and only if the report should be generated.
        Since:
        2.11

      • isGeneratedWhenNoResults

        protected boolean isGeneratedWhenNoResults()
        Whether the report should be generated when there are no test results.
        Returns:
        true if and only if the report should be generated when there are no result files at all.
        Since:
        2.11

      • setTitle

        public abstract void setTitle​(java.lang.String title)

      • getTitle

        public abstract java.lang.String getTitle()

      • setDescription

        public abstract void setDescription​(java.lang.String description)

      • getDescription

        public abstract java.lang.String getDescription()

      • executeReport

        public 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

      • canGenerateReport

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

      • getSurefireReportsDirectory

        protected abstract java.io.File getSurefireReportsDirectory​(org.apache.maven.project.MavenProject subProject)
        Gets the default surefire reports directory for the specified project.
        Parameters:
        subProject - the project to query.
        Returns:
        the default surefire reports directory for the specified project.

      • getName

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

      • getDescription

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

      • getOutputName

        public abstract java.lang.String getOutputName()

      • getBundle

        protected abstract LocalizedProperties getBundle​(java.util.Locale locale,
                                                 java.lang.ClassLoader resourceBundleClassLoader)

      • getConsoleLogger

        protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger()