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

Class SurefireReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.maven.plugins.surefire.report.AbstractSurefireReport

org.apache.maven.plugins.surefire.report.SurefireReport

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:

SurefireOnlyReport

@Mojo(name="report")
@Execute(lifecycle="surefire",
         phase=TEST)
public class SurefireReport
extends AbstractSurefireReport

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

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

Constructor	Description
SurefireReport(org.codehaus.plexus.i18n.I18N i18n)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getI18Nsection()
java.lang.String	getOutputName()	Deprecated. use getOutputPath() instead
java.lang.String	getOutputPath()
protected 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.plugins.surefire.report.AbstractSurefireReport

canGenerateReport, executeReport, getConsoleLogger, getDescription, getI18N, getI18nString, getName, getProject, getReactorProjects

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

Constructor Detail

SurefireReport

@Inject
public SurefireReport(org.codehaus.plexus.i18n.I18N i18n)

Method Detail

getSurefireReportsDirectory

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

Description copied from class: AbstractSurefireReport

Gets the default surefire reports directory for the specified project.

Specified by:

getSurefireReportsDirectory in class AbstractSurefireReport

Parameters:

subProject - the project to query

Returns:

the default surefire reports directory for the specified project

getOutputName

@Deprecated
public java.lang.String getOutputName()

Deprecated.

use getOutputPath() instead

getOutputPath

public java.lang.String getOutputPath()

Description copied from class: AbstractSurefireReport

Specified by:

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

Specified by:

getOutputPath in class AbstractSurefireReport

isSkipped

protected boolean isSkipped()

Description copied from class: AbstractSurefireReport

Whether the report should be generated or not.

Overrides:

isSkipped in class AbstractSurefireReport

Returns:

true if and only if the report should be generated

isGeneratedWhenNoResults

protected boolean isGeneratedWhenNoResults()

Description copied from class: AbstractSurefireReport

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

Overrides:

isGeneratedWhenNoResults in class AbstractSurefireReport

Returns:

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

getI18Nsection

protected java.lang.String getI18Nsection()

Specified by:

getI18Nsection in class AbstractSurefireReport

Returns:

the according string for the section