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

Class SurefireReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo

org.apache.maven.plugins.surefire.report.SurefireReportMojo

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:

SurefireReportOnlyMojo

@Mojo(name="report",
      inheritByDefault=false)
@Execute(lifecycle="surefire",
         phase=TEST)
public class SurefireReportMojo
extends AbstractSurefireReportMojo

Creates a nicely formatted Surefire Test Report in html format.

Author:

Johnny R. Ruiz III

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

Method Summary

Modifier and Type	Method	Description
protected LocalizedProperties	getBundle(Locale locale, ClassLoader resourceBundleClassLoader)
String	getDescription()
String	getOutputName()
protected File	getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)	Gets the default surefire reports directory for the specified project.
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.
void	setDescription(String description)
void	setTitle(String title)

Methods inherited from class org.apache.maven.plugins.surefire.report.AbstractSurefireReportMojo

canGenerateReport, executeReport, getConsoleLogger, getDescription, getName, getProject

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

SurefireReportMojo

public SurefireReportMojo()

Method Details

getSurefireReportsDirectory

protected File getSurefireReportsDirectory(org.apache.maven.project.MavenProject subProject)

Description copied from class: AbstractSurefireReportMojo

Gets the default surefire reports directory for the specified project.

Specified by:

getSurefireReportsDirectory in class AbstractSurefireReportMojo

Parameters:

subProject - the project to query.

Returns:

the default surefire reports directory for the specified project.

getOutputName

public String getOutputName()

Description copied from class: AbstractSurefireReportMojo

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

Specified by:

getOutputName in class AbstractSurefireReportMojo

getBundle

protected LocalizedProperties getBundle(Locale locale,
 ClassLoader resourceBundleClassLoader)

Specified by:

getBundle in class AbstractSurefireReportMojo

isSkipped

protected boolean isSkipped()

Description copied from class: AbstractSurefireReportMojo

Whether the report should be generated or not.

Overrides:

isSkipped in class AbstractSurefireReportMojo

Returns:

true if and only if the report should be generated.

isGeneratedWhenNoResults

protected boolean isGeneratedWhenNoResults()

Description copied from class: AbstractSurefireReportMojo

Whether the report should be generated when there are no test results.

Overrides:

isGeneratedWhenNoResults in class AbstractSurefireReportMojo

Returns:

true if and only if the report should be generated when there are no result files at all.

setTitle

public void setTitle(String title)

Specified by:

setTitle in class AbstractSurefireReportMojo

getTitle

public String getTitle()

Specified by:

getTitle in class AbstractSurefireReportMojo

setDescription

public void setDescription(String description)

Specified by:

setDescription in class AbstractSurefireReportMojo

getDescription

public String getDescription()

Specified by:

getDescription in class AbstractSurefireReportMojo