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

Constructor Summary

Constructors

Constructor and Description
AbstractSurefireReportMojo()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	executeReport(Locale locale)
protected abstract LocalizedProperties	getBundle(Locale locale, ClassLoader resourceBundleClassLoader)
protected org.apache.maven.plugin.surefire.log.api.ConsoleLogger	getConsoleLogger()
abstract String	getDescription()
String	getDescription(Locale locale)
String	getName(Locale locale)
abstract String	getOutputName()
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, 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(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 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(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()