Interface Contributor.Context

Enclosing interface:
Contributor

public static interface Contributor.Context
The context to contribute sections for.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the DOM element representing the execution or test node.
    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.
    Returns the path to the source XML file.
    Returns the path to the target HTML file.
  • Method Details

    • element

      Element element()
      Returns the DOM element representing the execution or test node.
      Returns:
      the DOM element representing the execution or test node
    • sourceXmlFile

      Path sourceXmlFile()
      Returns the path to the source XML file.
      Returns:
      the path to the source XML file
    • targetHtmlFile

      Path targetHtmlFile()
      Returns the path to the target HTML file.
      Returns:
      the path to the target HTML file
    • relativizeToTargetDirectory

      @API(status=EXPERIMENTAL, since="0.2.1") 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 - The path to relativize
      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
      Since:
      0.2.1