Package org.sentrysoftware.maven.metricshub.connector

Class ConnectorsDirectoryReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.sentrysoftware.maven.metricshub.connector.AbstractConnectorReport
org.sentrysoftware.maven.metricshub.connector.ConnectorsDirectoryReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
@Mojo(name="connectors-directory", aggregator=false, defaultPhase=SITE, requiresDependencyResolution=RUNTIME, requiresOnline=false, requiresProject=true, threadSafe=true) public class ConnectorsDirectoryReport extends AbstractConnectorReport
This Maven report goal builds an HTML Page for the Connectors Directory. It is invoked during the Maven site generation process.
It takes the source code of the connectors as input then generates a report that describes the supported platforms, tags, and connectors.

This plugin goal is a report goal that works in the site build lifecycle. It simply needs to be declared in the report section of the pom.xml.

The goal actually reads the .yaml files (Connectors) located in ${sourceDirectory} and produces HTML Web pages that are decorated using the specified Maven skin in site.xml.

  • Field Summary

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectorsDirectoryReport()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription(Locale locale)
     
    String
    getName(Locale locale)
     
    String
    getOutputName()
     
    static String
    kebabCase(String text)
    Converts the given text to kebab-case.

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    canGenerateReport, execute, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.apache.maven.reporting.MavenReport

    getOutputPath

  • Constructor Details

    • ConnectorsDirectoryReport

      public ConnectorsDirectoryReport()

  • Method Details

    • getDescription

      public String getDescription(Locale locale)

    • getName

      public String getName(Locale locale)

    • getOutputName

      public String getOutputName()

    • kebabCase

      public static String kebabCase(String text)
      Converts the given text to kebab-case.
      Parameters:
      text - The string to convert.
      Returns:
      The kebab-case text.