Class AbstractSurefireReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.surefire.report.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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
void
executeReport
(Locale locale) protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger
getDescription
(Locale locale) protected org.codehaus.plexus.i18n.I18N
protected abstract String
protected String
getI18nString
(Locale locale, String key) abstract String
protected org.apache.maven.project.MavenProject
protected List
<org.apache.maven.project.MavenProject> protected abstract File
getSurefireReportsDirectory
(org.apache.maven.project.MavenProject subProject) Gets the default surefire reports directory for the specified project.protected boolean
Whether the report should be generated when there are no test results.protected boolean
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 Details
-
AbstractSurefireReport
public AbstractSurefireReport()
-
-
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
-
executeReport
- Specified by:
executeReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.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.
-
getI18nString
- Parameters:
locale
- The localekey
- The key to search for- Returns:
- The text appropriate for the locale.
-
getI18N
- Parameters:
locale
- The local.- Returns:
- I18N for the locale
-
getI18Nsection
- Returns:
- The according string for the section.
-
getName
-
getDescription
-
getOutputName
-
getConsoleLogger
protected final org.apache.maven.plugin.surefire.log.api.ConsoleLogger getConsoleLogger() -
getProject
protected org.apache.maven.project.MavenProject getProject()- Overrides:
getProject
in classorg.apache.maven.reporting.AbstractMavenReport
-
getReactorProjects
-