Top Description Inners Methods
org.opentest4j.reporting.tooling.spi.htmlreport

public Interface Contributor

Annotations
@API
status:EXPERIMENTAL
since:0.2.0
Imports
org.apiguardian.api.API, org.w3c.dom.Element, java.nio.file.Path, java.util.List
Implementations of this interface can contribute additional sections to the HTML report when registered via the Java service loader mechanism.
Since
0.2.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Contributor.Context

The context to contribute sections for.

Method Summary

Modifier and TypeMethod and Description
public default List<Section>

Returns:

additional sections to be rendered
contributeSectionsForExecution(Contributor.Context
the DOM element representing the execution
context)

Contribute additional sections for the given execution element.

public default List<Section>

Returns:

additional sections to be rendered
contributeSectionsForTestNode(Contributor.Context
the DOM element representing the test node
context)

Contribute additional sections for the given test node element.

Method Detail

contributeSectionsForExecutionback to summary
public default List<Section> contributeSectionsForExecution(Contributor.Context context)

Contribute additional sections for the given execution element.

Parameters
context:Contributor.Context

the DOM element representing the execution

Returns:List<Section>

additional sections to be rendered

contributeSectionsForTestNodeback to summary
public default List<Section> contributeSectionsForTestNode(Contributor.Context context)

Contribute additional sections for the given test node element.

Parameters
context:Contributor.Context

the DOM element representing the test node

Returns:List<Section>

additional sections to be rendered

org.opentest4j.reporting.tooling.spi.htmlreport back to summary

public Interface Contributor.Context

The context to contribute sections for.

Method Summary

Modifier and TypeMethod and Description
public Element

Returns:

the DOM element representing the execution or test node
element()

Returns the DOM element representing the execution or test node.

public Path

Returns:

the relative path of the supplied path from the parent directory of the target HTML file or path itself if it cannot be relativized
relativizeToTargetDirectory(Path
The path to relativize
path)

Returns the relative path of the supplied path from the parent directory of the target HTML file or path itself if it cannot be relativized.

public Path

Returns:

the path to the source XML file
sourceXmlFile()

Returns the path to the source XML file.

public Path

Returns:

the path to the target HTML file
targetHtmlFile()

Returns the path to the target HTML file.

Method Detail

elementback to summary
public Element element()

Returns the DOM element representing the execution or test node.

Returns:Element

the DOM element representing the execution or test node

relativizeToTargetDirectoryback to summary
public Path relativizeToTargetDirectory(Path path)

Returns the relative path of the supplied path from the parent directory of the target HTML file or path itself if it cannot be relativized.

Parameters
path:Path

The path to relativize

Returns:Path

the relative path of the supplied path from the parent directory of the target HTML file or path itself if it cannot be relativized

Annotations
@API
status:EXPERIMENTAL
since:0.2.1
Since
0.2.1
sourceXmlFileback to summary
public Path sourceXmlFile()

Returns the path to the source XML file.

Returns:Path

the path to the source XML file

targetHtmlFileback to summary
public Path targetHtmlFile()

Returns the path to the target HTML file.

Returns:Path

the path to the target HTML file