A B C D E F G H I J R S T U V

A

AbstractClassPathCategoryResourceProvider - Class in de.smartics.testdoc.report.resource

Locates category resources on the class path.

AbstractClassPathCategoryResourceProvider(String) - Constructor for class de.smartics.testdoc.report.resource. AbstractClassPathCategoryResourceProvider

Default constructor.

acceptCategory(String) - Method in class de.smartics.testdoc.report.export.doc. SelectionFilter

Checks whether or not the category is accepted to display the so tagged scenario.

acceptScenario(ScenarioTestDoc) - Method in class de.smartics.testdoc.report.export.doc. SelectionFilter

Checks if the scenario is accepted.

addIndex(ExportIndex) - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Adds the given index to the list of indexes.

addItem(T) - Method in interface de.smartics.testdoc.report.index. Section

Adds the given item to this section.

addItem(T) - Method in class de.smartics.testdoc.report.index. StaticSection

Adds the given item to this section.

addLink(String, String) - Method in class de.smartics.testdoc.report.export.doc. ImageHelper

Adds the link to the map.

addSubSection(Section<T>) - Method in interface de.smartics.testdoc.report.index. Section

Adds the given sub section to this section.

addSubSection(Section<T>) - Method in class de.smartics.testdoc.report.index. StaticSection

Adds the given sub section to this section.

addTestCaseReportId(ReportId) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Adds the report ID to the list of IDs to render test case report references.

addTestMethod(JUnitTestMethodDoc) - Method in class de.smartics.testdoc.report.junit. JUnitTestCaseDoc

addToIndex(UnitTestDoc) - Method in interface de.smartics.testdoc.report.index. ExportIndex

Adds the given test documentation instance to the index.

addToIndex(UnitTestDoc) - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Adds the given test documentation instance to the index.

addToIndex(UnitTestDoc) - Method in class de.smartics.testdoc.report.index. UutNameIndex

Adds the given test documentation instance to the index.

addToIndex(UnitTestDoc) - Method in class de.smartics.testdoc.report.index. UutPackageIndex

Adds the given test documentation instance to the index.

addUutReportId(ReportId) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Adds the report ID to the list of IDs to render UUT report references.

ALL_FILTER - Static variable in class de.smartics.testdoc.report.export.doc. SelectionFilter

Constant to define a filter to include or exclude everything.

B

build() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Constructs instances of InformationFilter.

C

CategoryResource - Class in de.smartics.testdoc.report.resource

Descriptor of a category.

CategoryResource(String) - Constructor for class de.smartics.testdoc.report.resource. CategoryResource

Convenience constructor if icon location is null.

CategoryResource(String, URL) - Constructor for class de.smartics.testdoc.report.resource. CategoryResource

Default constructor.

CategoryResourceLoader - Class in de.smartics.testdoc.report.resource

Service loader to load category resource descriptors.

CategoryResourceProvider - Interface in de.smartics.testdoc.report.resource

Provides access to category resources.

clearCache() - Method in class de.smartics.testdoc.report.junit. DirectoryJUnitTestCaseManager

Removes all instances from the cache.

clearCache() - Method in interface de.smartics.testdoc.report.junit. JUnitTestCaseManager

Removes all instances from the cache.

containsSubSections() - Method in interface de.smartics.testdoc.report.index. Section

Checks if the given section contains sub sections.

containsSubSections() - Method in class de.smartics.testdoc.report.index. StaticSection

Checks if the given section contains sub sections.

createHelper(ReportConfig) - Method in class de.smartics.testdoc.report.export.doc. IndexProvider

Creates the helper that essentially encapsulates the index of test documentation.

D

de.smartics.testdoc.report.export.doc - package de.smartics.testdoc.report.export.doc

Provides helpers to pass business information to the renderers.

de.smartics.testdoc.report.export.doc.link.strategy - package de.smartics.testdoc.report.export.doc.link.strategy

Provides implementation strategies to create links to external reports.

de.smartics.testdoc.report.index - package de.smartics.testdoc.report.index

Provides classes to build and render indices.

de.smartics.testdoc.report.junit - package de.smartics.testdoc.report.junit

Provides helpers to read surefire's JUnit report and link to the information found there.

de.smartics.testdoc.report.resource - package de.smartics.testdoc.report.resource

DefaultCategoryResourceProvider - Class in de.smartics.testdoc.report.resource

Locates testdoc default category resources.

DefaultCategoryResourceProvider() - Constructor for class de.smartics.testdoc.report.resource. DefaultCategoryResourceProvider

Default constructor.

DirectoryJUnitTestCaseManager - Class in de.smartics.testdoc.report.junit

Provides access to test case information.

DirectoryJUnitTestCaseManager(File) - Constructor for class de.smartics.testdoc.report.junit. DirectoryJUnitTestCaseManager

Default constructor.

E

EMPTY - Static variable in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

An empty report reference instance that prohibits adding information.

equals(Object) - Method in class de.smartics.testdoc.report.resource. CategoryResource

Returns true if the given object is semantically equal to the given object, false otherwise.

evict(Type) - Method in class de.smartics.testdoc.report.junit. DirectoryJUnitTestCaseManager

Allows to selectively remove instances from the cache.

evict(Type) - Method in interface de.smartics.testdoc.report.junit. JUnitTestCaseManager

Allows to selectively remove instances from the cache.

ExportIndex - Interface in de.smartics.testdoc.report.index

The export index creates the configured indexes.

ExportMultiIndex - Class in de.smartics.testdoc.report.index

Provides means to handle multiple export indexes.

ExportMultiIndex() - Constructor for class de.smartics.testdoc.report.index. ExportMultiIndex

Default constructor.

ExternalReportReferences - Class in de.smartics.testdoc.report.export.doc

Manages report instances and their grouping.

ExternalReportReferences(ExternalReportFactory) - Constructor for class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Default constructor.

F

filter(List<String>) - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Filters the given categories according the the given report configuration.

filterCategories(List<String>) - Method in class de.smartics.testdoc.report.export.doc. SelectionFilter

Filters the list of categories to retain only those that are accepted by SelectionFilter.acceptCategory(String).

filterScenarios(List<ScenarioTestDoc>) - Method in class de.smartics.testdoc.report.export.doc. SelectionFilter

Filters scenarios by their categories.

filterScenarios(List<ScenarioTestDoc>) - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Filters scenarios by their categories according the the given report configuration.

G

get(ReportId) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the report with the given ID.

getIconId() - Method in exception de.smartics.testdoc.report.resource. IconNotFoundException

Returns the identifier of the icon that has not been found.

getIconLocation() - Method in class de.smartics.testdoc.report.resource. CategoryResource

Returns the location of the category icon.

getImageHelper() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

Returns the configuration of links to images used in reports.

getImageHelper() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Returns the configuration of links to images used in reports.

getImageLink(String) - Method in class de.smartics.testdoc.report.export.doc. ImageHelper

Returns the link for the given identifier.

getImageLink(JUnitTestMethodDoc.ResultType) - Method in class de.smartics.testdoc.report.export.doc. ImageHelper

Returns the link for the given identifier.

getIndex() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Returns the index of test documentation.

getIndexes() - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Returns a reference to an unmodifiable instance of the list of indexes.

getInformationFilter() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

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

getInformationFilter() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

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

getItems() - Method in interface de.smartics.testdoc.report.index. Section

Returns the list of items associated with this section.

getItems() - Method in class de.smartics.testdoc.report.index. StaticSection

Returns the list of items associated with this section.

getJunitManager() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

Returns the manager to access JUnit report information.

getJunitManager() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Returns the manager to access JUnit report information.

getLabel() - Method in class de.smartics.testdoc.report.resource. CategoryResource

Returns the label of the category to be displayed.

getName() - Method in interface de.smartics.testdoc.report.index. Section

Returns the name of this section.

getName() - Method in class de.smartics.testdoc.report.index. StaticSection

Returns the name of this section.

getProperties() - Method in interface de.smartics.testdoc.report.index. Section

Returns the properties associated with this section.

getProperties() - Method in class de.smartics.testdoc.report.index. StaticSection

Returns the properties associated with this section.

getReports(List<ReportId>) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the list of reports with the given IDs.

getReports() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

Returns the external reports to reference to.

getReports() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Returns the external reports to reference to.

getResource(Locale, Class<?>) - Method in class de.smartics.testdoc.report.resource. AbstractClassPathCategoryResourceProvider

Returns the category resource for the given category type.

getResource(String) - Method in class de.smartics.testdoc.report.resource. CategoryResourceLoader

Returns the category resource for the given category type.

getResource(Locale, String) - Method in class de.smartics.testdoc.report.resource. CategoryResourceLoader

Returns the category resource for the given category type.

getResource(Class<?>) - Method in class de.smartics.testdoc.report.resource. CategoryResourceLoader

Returns the category resource for the given category type.

getResource(Locale, Class<?>) - Method in class de.smartics.testdoc.report.resource. CategoryResourceLoader

Returns the category resource for the given category type.

getResource(Locale, Class<?>) - Method in interface de.smartics.testdoc.report.resource. CategoryResourceProvider

Returns the category resource for the given category type.

getResultType() - Method in class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Returns the result type of the test case.

getSection() - Method in interface de.smartics.testdoc.report.index. ExportIndex

Returns a reference to the root section of the index.

getSection() - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Returns a reference to the root section of the index.

getSection() - Method in class de.smartics.testdoc.report.index. UutNameIndex

Returns a reference to the root section of the index.

getSection() - Method in class de.smartics.testdoc.report.index. UutPackageIndex

Returns a reference to the root section of the index.

getSectionName() - Method in interface de.smartics.testdoc.report.index. ExportIndex

Returns the name of the section generated by this index.

getSectionName() - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Returns the name of the section generated by this index.

getSectionName() - Method in class de.smartics.testdoc.report.index. UutNameIndex

Returns the name of the section generated by this index.

getSectionName() - Method in class de.smartics.testdoc.report.index. UutPackageIndex

Returns the name of the section generated by this index.

getSelectionFilter() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

Returns the category classes of test scenarios that should be filtered.

getSubSections() - Method in interface de.smartics.testdoc.report.index. Section

Returns the list of sub sections to this section.

getSubSections() - Method in class de.smartics.testdoc.report.index. StaticSection

Returns the list of sub sections to this section.

getTestCaseReportIds() - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the list of report IDs that are to referenced from a test case.

getTestCaseReports() - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the ordered list of report IDs to render for the test case.

getTestCaseType() - Method in class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Returns the type of the test case class that contains the test method.

getTestMethod(String) - Method in class de.smartics.testdoc.report.junit. JUnitTestCaseDoc

getTestMethodName() - Method in class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Returns the name of the test method.

getTime() - Method in class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Returns the reported duration of the test case execution.

getUnitTestDocComparator() - Method in class de.smartics.testdoc.report.export.doc. ReportConfig

Returns the comparator to use to sort the rendering of unit test documentation.

getUnitTestDocComparator() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Returns the comparator to use to sort the rendering of unit test documentation.

getUutReportIds() - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the list of report IDs that are to referenced from a UUT.

getUutReports() - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Returns the ordered list of report IDs to render for the UUT.

H

hashCode() - Method in class de.smartics.testdoc.report.resource. CategoryResource

Returns the hash code of the object.

I

IconNotFoundException - Exception in de.smartics.testdoc.report.resource

Signals that a references icon has not been found at the specified location.

IconNotFoundException(String) - Constructor for exception de.smartics.testdoc.report.resource. IconNotFoundException

Convenience constructor.

IconNotFoundException(String, Throwable) - Constructor for exception de.smartics.testdoc.report.resource. IconNotFoundException

Default constructor.

ImageHelper - Class in de.smartics.testdoc.report.export.doc

Helps to provide links to images.

ImageHelper(String) - Constructor for class de.smartics.testdoc.report.export.doc. ImageHelper

Default constructor.

IndexProvider - Class in de.smartics.testdoc.report.export.doc

Checks whether or not the test documentation has been gathered successfully.

IndexProvider(String) - Constructor for class de.smartics.testdoc.report.export.doc. IndexProvider

Convenience constructor using JMX object name JmxExportAdapterClient.OBJECT_NAME.

IndexProvider(String, String) - Constructor for class de.smartics.testdoc.report.export.doc. IndexProvider

Default constructor.

InformationFilter - Class in de.smartics.testdoc.report.export.doc

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

InformationFilter.Builder - Class in de.smartics.testdoc.report.export.doc

The builder to construct instances of InformationFilter.

InformationFilter.Builder() - Constructor for class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

INSTANCE - Static variable in class de.smartics.testdoc.report.resource. CategoryResourceLoader

The singleton instance of the resource loader.

isEmpty() - Method in interface de.smartics.testdoc.report.index. ExportIndex

Checks if this or any sub sections contains at least one item.

isEmpty() - Method in class de.smartics.testdoc.report.index. ExportMultiIndex

Checks if this or any sub sections contains at least one item.

isEmpty() - Method in interface de.smartics.testdoc.report.index. Section

Checks if this section or any sub sections contains at least one item.

isEmpty() - Method in class de.smartics.testdoc.report.index. StaticSection

Checks if this section or any sub sections contains at least one item.

isEmpty() - Method in class de.smartics.testdoc.report.index. UutNameIndex

Checks if this or any sub sections contains at least one item.

isEmpty() - Method in class de.smartics.testdoc.report.index. UutPackageIndex

Checks if this or any sub sections contains at least one item.

isIndexProvided() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Checks if test documentation information is provided.

isJUnitReportInformationRequested() - Method in class de.smartics.testdoc.report.export.doc. TestDocHelper

Checks whether or not to include JUnit report information.

isShowCategories() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter

Returns the flag that tells whether ( true) or not ( false) the categories should be shown when enumerating the test cases.

isShowIndexOfIndices() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter

Returns the flag that tells whether ( true) or not ( false) the index over all indices should be shown.

isShowNumbering() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter

Returns the flag that tells whether ( true) or not ( false) the number column should be shown when enumerating the test cases.

isShowTestCase() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter

Returns the flag that tells whether ( true) or not ( false) the test case name should be shown.

isShowTestStatus() - Method in class de.smartics.testdoc.report.export.doc. InformationFilter

Returns the flag that tells whether ( true) or not ( false) the test status column should be shown when enumerating the test cases.

J

JUnitTestCaseDoc - Class in de.smartics.testdoc.report.junit

Provides information about a single test case.

JUnitTestCaseDoc() - Constructor for class de.smartics.testdoc.report.junit. JUnitTestCaseDoc

Default constructor.

JUnitTestCaseManager - Interface in de.smartics.testdoc.report.junit

Provides access to JUnit XML test case reports.

JUnitTestMethodDoc - Class in de.smartics.testdoc.report.junit

Contains the information of one JUnit test case result.

JUnitTestMethodDoc(JUnitTestMethodDoc.ResultType, String, String, String) - Constructor for class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Convenience constructor.

JUnitTestMethodDoc(JUnitTestMethodDoc.ResultType, String, Type, String) - Constructor for class de.smartics.testdoc.report.junit. JUnitTestMethodDoc

Default constructor.

JUnitTestMethodDoc.ResultType - Enum in de.smartics.testdoc.report.junit

The result type of the test case.

JUnitXmlReportParser - Class in de.smartics.testdoc.report.junit

Reads the in-memory representation of a JUnit XML report.

JUnitXmlReportParser() - Constructor for class de.smartics.testdoc.report.junit. JUnitXmlReportParser

Default constructor.

R

read(InputStream) - Method in class de.smartics.testdoc.report.junit. JUnitXmlReportParser

Reads the XML information from the stream.

readTestCase(Type) - Method in class de.smartics.testdoc.report.junit. DirectoryJUnitTestCaseManager

Reads the test case for the given test case type.

readTestCase(Type) - Method in interface de.smartics.testdoc.report.junit. JUnitTestCaseManager

Reads the test case for the given test case type.

registerReport(ReportId, LinkConstructorStrategy) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Registers a report with the given identifier and strategy.

registerReport(boolean, ReportId, LinkConstructorStrategy) - Method in class de.smartics.testdoc.report.export.doc. ExternalReportReferences

Registers a report with the given identifier and strategy with a guard.

ReportConfig - Class in de.smartics.testdoc.report.export.doc

The configuration to control the generation of the report.

ReportConfig() - Constructor for class de.smartics.testdoc.report.export.doc. ReportConfig

Convenience constructor with default values for structures not needed for non visual reports.

ReportConfig(SelectionFilter, InformationFilter, JUnitTestCaseManager, ImageHelper, ExternalReportReferences, Comparator<UnitTestDoc>) - Constructor for class de.smartics.testdoc.report.export.doc. ReportConfig

Default constructor.

S

Section< T extends Serializable> - Interface in de.smartics.testdoc.report.index

A section defines a collection of items that are grouped by a set of defined criteria.

SECTION_NAME - Static variable in class de.smartics.testdoc.report.index. ExportMultiIndex

The name of the section generated by this index.

SECTION_NAME - Static variable in class de.smartics.testdoc.report.index. UutNameIndex

The name of the section generated by this index.

SECTION_NAME - Static variable in class de.smartics.testdoc.report.index. UutPackageIndex

The name of the section generated by this index.

SelectionFilter - Class in de.smartics.testdoc.report.export.doc

Filter on test cases based on categories.

SelectionFilter(List<String>, List<String>) - Constructor for class de.smartics.testdoc.report.export.doc. SelectionFilter

Default constructor.

setShowCategories(boolean) - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Sets the flag that tells whether ( true) or not ( false) the categories should be shown when enumerating the test cases.

setShowIndexOfIndices(boolean) - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Sets the flag that tells whether ( true) or not ( false) the index over all indices should be shown.

setShowNumbering(boolean) - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Sets the flag that tells whether ( true) or not ( false) the number column should be shown when enumerating the test cases.

setShowTestCase(boolean) - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Sets the flag that tells whether ( true) or not ( false) the test case name should be shown.

setShowTestStatus(boolean) - Method in class de.smartics.testdoc.report.export.doc. InformationFilter.Builder

Sets the flag that tells whether ( true) or not ( false) the test status column should be shown when enumerating the test cases.

SHOW_DEFAULTS - Static variable in class de.smartics.testdoc.report.export.doc. InformationFilter

A convenience instance with the default configuration.

STANDARD - Static variable in class de.smartics.testdoc.report.export.doc. SelectionFilter

Standard filter that does include everything and exclude nothing.

StaticSection< T extends Serializable> - Class in de.smartics.testdoc.report.index

The implementation provides a static view on sections.

StaticSection(String) - Constructor for class de.smartics.testdoc.report.index. StaticSection

Convenience constructor with an empty set of properties.

StaticSection(String, Map<String, Serializable>) - Constructor for class de.smartics.testdoc.report.index. StaticSection

Default constructor.

T

TESTCASE_ERROR - Static variable in class de.smartics.testdoc.report.export.doc. ImageHelper

The key to select the link to an image that signals a test case error.

TESTCASE_FAILURE - Static variable in class de.smartics.testdoc.report.export.doc. ImageHelper

The key to select the link to an image that signals a test case failure.

TESTCASE_SKIPPED - Static variable in class de.smartics.testdoc.report.export.doc. ImageHelper

The key to select the link to an image that signals that the test case has been skipped.

TESTCASE_SUCCESS - Static variable in class de.smartics.testdoc.report.export.doc. ImageHelper

The key to select the link to an image that signals a test case success.

TestCaseReportException - Exception in de.smartics.testdoc.report.junit

Signals that a requested test case cannot be read.

TestCaseReportException(String, Throwable) - Constructor for exception de.smartics.testdoc.report.junit. TestCaseReportException

Constructor.

TestDocHelper - Class in de.smartics.testdoc.report.export.doc

Helper to access test documentation information and provides access to configuration information.

TestDocHelper(UnitTestDocIndex) - Constructor for class de.smartics.testdoc.report.export.doc. TestDocHelper

Convenience constructor to create an instance with a filter that accepts all categories and shows defaults.

TestDocHelper(UnitTestDocIndex, ReportConfig) - Constructor for class de.smartics.testdoc.report.export.doc. TestDocHelper

Default constructor.

toString() - Method in class de.smartics.testdoc.report.resource. CategoryResource

Returns the string representation of the object.

U

UutNameIndex - Class in de.smartics.testdoc.report.index

Generates an index on the names of the UUTs.

UutNameIndex() - Constructor for class de.smartics.testdoc.report.index. UutNameIndex

Default constructor.

UutPackageIndex - Class in de.smartics.testdoc.report.index

Generates an index on the packages the UUT belong to.

UutPackageIndex() - Constructor for class de.smartics.testdoc.report.index. UutPackageIndex

Default constructor.

V

valueOf(String) - Static method in enum de.smartics.testdoc.report.junit. JUnitTestMethodDoc.ResultType

Returns the enum constant of this type with the specified name.

values() - Static method in enum de.smartics.testdoc.report.junit. JUnitTestMethodDoc.ResultType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I J R S T U V