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:

ContextEnabled, Mojo, MavenMultiPageReport, MavenReport

Direct Known Subclasses:

FailsafeReportMojo, SurefireReportMojo

public abstract class AbstractSurefireReportMojo
extends AbstractMavenReport

Abstract base class for reporting test results using Surefire.

Author:

Stephen Connolly

Field Summary

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

AbstractSurefireReportMojo()

Method Summary

boolean	canGenerateReport()
void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
abstract String	getOutputName()
protected MavenProject	getProject()
protected Renderer	getSiteRenderer()
protected abstract File	getSurefireReportsDirectory(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, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, 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

executeReport

public void executeReport(Locale locale)
                   throws MavenReportException

Specified by:

executeReport in class AbstractMavenReport

Throws:

MavenReportException

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface MavenReport

Overrides:

canGenerateReport in class AbstractMavenReport

getSurefireReportsDirectory

protected abstract File getSurefireReportsDirectory(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)

getSiteRenderer

protected Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class AbstractMavenReport

getProject

protected MavenProject getProject()

Specified by:

getProject in class AbstractMavenReport

getOutputName

public abstract String getOutputName()

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractMavenReport