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

Class AbstractSurefireReport

  • 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:
    FailsafeOnlyReport, SurefireReport
    public abstract class AbstractSurefireReport
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

        locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, 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 
      Modifier Constructor Description
      protected AbstractSurefireReport​(org.codehaus.plexus.i18n.I18N i18n)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canGenerateReport()  
      void executeReport​(java.util.Locale locale)
      protected org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger()  
      java.lang.String getDescription​(java.util.Locale locale)
      protected org.codehaus.plexus.i18n.I18N getI18N​(java.util.Locale locale)  
      protected abstract java.lang.String getI18Nsection()  
      protected java.lang.String getI18nString​(java.util.Locale locale, java.lang.String key)  
      java.lang.String getName​(java.util.Locale locale)
      abstract java.lang.String getOutputName()
      protected org.apache.maven.project.MavenProject getProject()  
      protected java.util.List<org.apache.maven.project.MavenProject> getReactorProjects()  
      protected abstract java.io.File getSurefireReportsDirectory​(org.apache.maven.project.MavenProject subProject)
      Gets the default surefire reports directory for the specified project.
      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.

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

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

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

        getOutputPath

    • Constructor Detail

      • AbstractSurefireReport

        protected AbstractSurefireReport​(org.codehaus.plexus.i18n.I18N i18n)

    • 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

      • executeReport

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

      • 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.

      • getI18nString

        protected java.lang.String getI18nString​(java.util.Locale locale,
                                         java.lang.String key)
        Parameters:
        locale - the locale
        key - the key to search fo
        Returns:
        the text appropriate for the locale.

      • getI18N

        protected org.codehaus.plexus.i18n.I18N getI18N​(java.util.Locale locale)
        Parameters:
        locale - the locale
        Returns:
        I18N for the locale

      • getI18Nsection

        protected abstract java.lang.String getI18Nsection()
        Returns:
        the according string for the section

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

      • 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

      • getReactorProjects

        protected java.util.List<org.apache.maven.project.MavenProject> getReactorProjects()