Package com.guinetik.terminaljavadocs.plugin

Class ModuleReport

java.lang.Object
com.guinetik.terminaljavadocs.plugin.ModuleReport
public class ModuleReport extends Object
Data transfer object representing a Maven module's report metadata.

Used by GenerateLandingPagesMojo to collect information about modules that have generated reports (coverage, xref) and render them into landing pages.

Example usage: 


 ModuleReport report = new ModuleReport(
     "my-module",
     "Core utilities library",
     "my-module"
 );
 // Use in template: report.getArtifactId() -> "my-module"
See Also:

  • Constructor Details

    • ModuleReport

      public ModuleReport(String artifactId, String description, String relativePath)
      Creates a new module report with the specified metadata.
      Parameters:
      artifactId - the Maven artifact ID of the module (e.g., "my-module")
      description - the module's description from pom.xml, may be null
      relativePath - the relative path from the landing page to this module's reports

  • Method Details

    • getArtifactId

      public String getArtifactId()
      Returns the Maven artifact ID of this module.
      Returns:
      the artifact ID, never null

    • getDescription

      public String getDescription()
      Returns the module's description from its pom.xml.
      Returns:
      the description, or null if not specified in the POM

    • getRelativePath

      public String getRelativePath()
      Returns the relative path from the landing page to this module's report directory.

      This path is used to construct links in the generated landing pages, e.g., ./my-module/jacoco/index.html.

      Returns:
      the relative path to the module's reports