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

Class AbstractSurefireReportMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.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

    localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool

    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
    AbstractSurefireReportMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    void
    executeReport(Locale locale)
    protected abstract LocalizedProperties
    getBundle(Locale locale, ClassLoader resourceBundleClassLoader)
     
    protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger
    getConsoleLogger()
     
    abstract String
    getDescription()
     
    String
    getDescription(Locale locale)
    String
    getName(Locale locale)
    abstract String
    getOutputName()
    protected org.apache.maven.project.MavenProject
    getProject()
     
    protected abstract File
    getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)
    Gets the default surefire reports directory for the specified project.
    abstract 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(String description)
     
    abstract void
    setTitle(String title)
     

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

    closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, 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 Details

    • AbstractSurefireReportMojo

      public AbstractSurefireReportMojo()

  • Method Details

    • 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(String title)

    • getTitle

      public abstract String getTitle()

    • setDescription

      public abstract void setDescription(String description)

    • getDescription

      public abstract String getDescription()

    • executeReport

      public void executeReport(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 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 String getName(Locale locale)

    • getDescription

      public String getDescription(Locale locale)

    • getOutputName

      public abstract String getOutputName()

    • getBundle

      protected abstract LocalizedProperties getBundle(Locale locale, ClassLoader resourceBundleClassLoader)

    • getConsoleLogger

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

    • getProject

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