A C D E F G I J L M N O P R S T X

A

AbstractOutputManager - Class in de.smartics.testdoc.maven.export

Export UnitTestDoc information to an output medium.

AbstractOutputManager(String, MessageHelper, AbstractReportExporter, List<ExportIndex>) - Constructor for class de.smartics.testdoc.maven.export. AbstractOutputManager

Default constructor.

AbstractPageRenderer - Class in de.smartics.testdoc.maven.export.sink

Base implementation of page renderers.

AbstractReportExporter - Class in de.smartics.testdoc.maven.export

Exports the test documentation to an output medium.

AbstractReportExporter(MessageHelper, TestDocHelper) - Constructor for class de.smartics.testdoc.maven.export. AbstractReportExporter

Default constructor.

AbstractReportMojo - Class in de.smartics.testdoc.maven

The abstract base implementation for reports.

AbstractReportMojo() - Constructor for class de.smartics.testdoc.maven. AbstractReportMojo

AbstractSourceReportMojo - Class in de.smartics.testdoc.maven

The abstract base implementation for reports.

AbstractSourceReportMojo() - Constructor for class de.smartics.testdoc.maven. AbstractSourceReportMojo

C

canGenerateReport() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

canGenerateReport() - Method in class de.smartics.testdoc.maven. TestDocReportMojo

coberturaLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the Cobertura test report to reference.

createStrategy(String, File, boolean, String) - Method in class de.smartics.testdoc.maven. AbstractSourceReportMojo

D

de.smartics.testdoc.maven - package de.smartics.testdoc.maven

de.smartics.testdoc.maven.export - package de.smartics.testdoc.maven.export

de.smartics.testdoc.maven.export.sink - package de.smartics.testdoc.maven.export.sink

de.smartics.testdoc.maven.export.xml - package de.smartics.testdoc.maven.export.xml

description - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The description of the report.

E

endScenario() - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

endScenario() - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

execute() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

Runs the report generation.

executeReport(Locale) - Method in class de.smartics.testdoc.maven. AbstractReportMojo

Configures the plugin logger.

executeReport(Locale) - Method in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Configures the plugin logger.

executeReport(Locale) - Method in class de.smartics.testdoc.maven. TestDocReportMojo

Configures the plugin logger.

export(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractOutputManager

export(UnitTestDoc, OutputStream) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

export(UnitTestDoc, OutputStream) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

export(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

Convenience method that matches the Sink design.

export(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

exporter - Variable in class de.smartics.testdoc.maven.export. AbstractOutputManager

The exporter that knows the format of the file to be written.

exportIndex(Locale) - Method in class de.smartics.testdoc.maven. TestDocReportMojo

exportSinkReport(List<ExportIndex>, UnitTestDocIndex) - Method in class de.smartics.testdoc.maven. TestDocReportMojo

exportXmlReport(List<ExportIndex>, UnitTestDocIndex) - Method in class de.smartics.testdoc.maven. TestDocReportMojo

F

factory - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The factory to create dependent artifacts.

finish() - Method in class de.smartics.testdoc.maven.export.sink. SinkOutputManager

finish() - Method in class de.smartics.testdoc.maven.export.xml. XmlOutputManager

G

getBundle(Locale) - Method in class de.smartics.testdoc.maven. AbstractReportMojo

Returns the resource bundle for the given locale.

getDescription(Locale) - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getFileExtension() - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

getInformationFilter() - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Returns the configuration that tells which report information is to be displayed.

getName(Locale) - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getOutputDirectory() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getOutputName() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getProject() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getSink() - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

Returns the output medium to write to.

getSiteRenderer() - Method in class de.smartics.testdoc.maven. AbstractReportMojo

getTestDocHelper() - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Returns the value for testDocHelper.

getXmlWriter() - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

Returns the output stream to write to.

I

imageHelper - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Configuration of links to images used in reports.

index - Variable in class de.smartics.testdoc.maven.export. AbstractOutputManager

The multi index to create the sections of the output document.

informationFilter - Variable in class de.smartics.testdoc.maven.export. AbstractReportExporter

The configuration that tells which report information is to be displayed.

init() - Method in class de.smartics.testdoc.maven.export. AbstractOutputManager

J

javadocLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the Javadoc report to reference.

javadocTestLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the Javadoc test report to reference.

junitManager - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The manager to access JUnit report information.

junitReportLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the JavaDoc report to reference.

L

linkCobertura - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the Cobertura test report when found.

linkJavadoc - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the Javadoc report when found.

linkJavadocTest - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the Javadoc test report when found.

linkSurefire - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the javadoc report when found.

linkXref - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the source code report (XRef) when found.

linkXrefTest - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to reference the source code report (XRef) when found.

locale - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The locale to use regardless of the report.

localRepository - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

Local Repository.

logLevel - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

Specifies the log level used for this plugin.

M

messages - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

messages - Variable in class de.smartics.testdoc.maven.export. AbstractOutputManager

The resource bundles with messages to display as labels in the generated report.

messages - Variable in class de.smartics.testdoc.maven.export. AbstractReportExporter

The resource bundles with messages to display as labels in the generated report.

messages - Variable in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

The resource bundles with messages to display as labels in the generated report.

N

name - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The name of the report used as title.

O

outputDirectory - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

Specifies the directory where the report will written to.

outputName - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The name of the report.

P

presentJUnitReport - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Controls whether to show test case information read from the JUnit XML reports.

project - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The Maven project.

R

renderBodyEnd() - Method in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

renderBodyStart() - Method in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

renderCategories(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderCategories(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderCategories(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderFooter() - Method in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

Renders the footer text.

renderJUnitStatus(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderJUnitStatus(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderJUnitStatus(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderJUnitStatusLink(JUnitTestMethodDoc.ResultType, String) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderPageEndAndFinalize() - Method in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

renderPageStart() - Method in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

renderReports(Type, List<ExternalReport>, TestMethodDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderRowNumber(int) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderRowNumber(int) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderRowNumber(int) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderScenario(int, ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Controls the output of a single scenario within the test documentation unit.

renderSentence(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderSentence(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderSentence(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderTableEnd(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderTableEnd(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTableStart(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Override if the report need to initialize the output before individual test documentation units are exported.

renderTableStart(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTestCase(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

renderTestCase(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTestCase(ScenarioTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

renderTestDocTypeEnd(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

The symmetric method to AbstractReportExporter.renderTestDocTypeStart(UnitTestDoc).

renderTestDocTypeEnd(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTestDocTypeStart(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Override to export the test doc unit start information.

renderTestDocTypeStart(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTestDocTypeStart(UnitTestDoc) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

Override to export the test doc unit start information.

renderTestDocUutReportLinks(Type, ExternalReportReferences) - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

Exports links to external reports.

renderTestDocUutReportLinks(Type, ExternalReportReferences) - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

renderTestDocUutReportLinks(Type, ExternalReportReferences) - Method in class de.smartics.testdoc.maven.export.xml. XmlExporter

Exports links to external reports.

reportName - Variable in class de.smartics.testdoc.maven.export. AbstractOutputManager

The name of the report to export.

reportName - Variable in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

reports - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

Helper to construct links to external reports.

resolver - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The resolver for resolving artifacts.

S

sink - Variable in class de.smartics.testdoc.maven.export.sink. AbstractPageRenderer

The output medium to write to.

SinkExporter - Class in de.smartics.testdoc.maven.export.sink

Exports the test documentation to a sink.

SinkExporter(MessageHelper, TestDocHelper, Sink) - Constructor for class de.smartics.testdoc.maven.export.sink. SinkExporter

Default constructor.

SinkOutputManager - Class in de.smartics.testdoc.maven.export.sink

Export UnitTestDoc information to a sink.

SinkOutputManager(String, MessageHelper, SinkExporter, List<ExportIndex>) - Constructor for class de.smartics.testdoc.maven.export.sink. SinkOutputManager

Default constructor.

siteRenderer - Variable in class de.smartics.testdoc.maven. AbstractReportMojo

The Doxia site renderer.

startScenario() - Method in class de.smartics.testdoc.maven.export. AbstractReportExporter

startScenario() - Method in class de.smartics.testdoc.maven.export.sink. SinkExporter

surefireLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the JavaDoc report to reference.

T

TESTDOC_NS - Static variable in class de.smartics.testdoc.maven.export.xml. XmlExporter

testDocHelper - Variable in class de.smartics.testdoc.maven.export. AbstractReportExporter

Provides access to configuration information.

TestDocReportMojo - Class in de.smartics.testdoc.maven

Generates XDoc reports.

TestDocReportMojo() - Constructor for class de.smartics.testdoc.maven. TestDocReportMojo

testDocs - Variable in class de.smartics.testdoc.maven.export. AbstractOutputManager

The cached test documentation instances.

X

XmlExporter - Class in de.smartics.testdoc.maven.export.xml

Exports the report information to plain XML.

XmlExporter(MessageHelper, TestDocHelper, XMLStreamWriter) - Constructor for class de.smartics.testdoc.maven.export.xml. XmlExporter

Default constructor.

XmlOutputManager - Class in de.smartics.testdoc.maven.export.xml

Manages the export of the report to XML.

XmlOutputManager(String, MessageHelper, XmlExporter, List<ExportIndex>) - Constructor for class de.smartics.testdoc.maven.export.xml. XmlOutputManager

Default constructor.

xrefLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the source code report (XRef) to reference.

xrefTestLocation - Variable in class de.smartics.testdoc.maven. AbstractSourceReportMojo

The location of the source code report (XRef) to reference.

A C D E F G I J L M N O P R S T X