Package org.apache.maven.plugin.plugin.report

Class GoalRenderer

java.lang.Object
org.apache.maven.reporting.AbstractMavenReportRenderer
org.apache.maven.plugin.plugin.report.AbstractPluginReportRenderer
org.apache.maven.plugin.plugin.report.GoalRenderer
All Implemented Interfaces:
org.apache.maven.reporting.MavenReportRenderer
public class GoalRenderer extends AbstractPluginReportRenderer

  • Field Details

    • reportOutputDirectory

      private final File reportOutputDirectory
      The directory where the generated site is written. Used for resolving relative links to javadoc.

    • descriptor

      private final org.apache.maven.plugin.descriptor.MojoDescriptor descriptor

    • disableInternalJavadocLinkValidation

      private final boolean disableInternalJavadocLinkValidation

    • log

      private final org.apache.maven.plugin.logging.Log log

  • Constructor Details

    • GoalRenderer

      public GoalRenderer(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.plugin.descriptor.MojoDescriptor descriptor, File reportOutputDirectory, boolean disableInternalJavadocLinkValidation, org.apache.maven.plugin.logging.Log log)

  • Method Details

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface org.apache.maven.reporting.MavenReportRenderer
      Overrides:
      getTitle in class AbstractPluginReportRenderer

    • renderBody

      protected void renderBody()
      Specified by:
      renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

    • filterParameters

      private static List<org.apache.maven.plugin.descriptor.Parameter> filterParameters(Collection<org.apache.maven.plugin.descriptor.Parameter> parameterList)
      Filter parameters to only retain those which must be documented, i.e. neither components nor read-only ones.
      Parameters:
      parameterList - not null
      Returns:
      the parameters list without components.

    • renderReportNotice

      private void renderReportNotice()

    • renderDescription

      private void renderDescription(String prefixKey, String description, boolean isHtmlMarkup)
      A description consists of a term/prefix and the actual description text

    • renderDescriptionPrefix

      private void renderDescriptionPrefix(String prefixKey)

    • renderAttributes

      private void renderAttributes()

    • renderAttribute

      private void renderAttribute(boolean condition, String attributeKey)

    • renderAttribute

      private void renderAttribute(String conditionAndCodeArgument, String attributeKey)

    • renderAttribute

      private void renderAttribute(boolean condition, String attributeKey, Optional<String> codeArgument)

    • renderParameterOverviewTable

      private void renderParameterOverviewTable(String title, Iterator<org.apache.maven.plugin.descriptor.Parameter> parameters)

    • renderTableCellWithCode

      private void renderTableCellWithCode(String text)

    • renderTableCellWithCode

      private void renderTableCellWithCode(String text, Optional<String> link)

    • renderParameterOverviewTableRow

      private void renderParameterOverviewTableRow(org.apache.maven.plugin.descriptor.Parameter parameter)

    • renderParameterDetails

      private void renderParameterDetails(Iterator<org.apache.maven.plugin.descriptor.Parameter> parameters)

    • renderDeprecatedParameterDescription

      private void renderDeprecatedParameterDescription(String deprecated, String context)

    • renderTableCellDetail

      private void renderTableCellDetail(String nameKey, String value)

    • renderDetail

      private void renderDetail(String param, String value)

    • renderDetail

      private void renderDetail(String param, String value, Optional<String> valueLink)

    • getPropertyFromExpression

      private static String getPropertyFromExpression(String expression)

    • getShortType

      static String getShortType(String type)

    • getShortTypeOfTypeArgument

      private static String getShortTypeOfTypeArgument(String type)

    • getShortTypeOfSimpleType

      private static String getShortTypeOfSimpleType(String type)

    • getLinkedType

      private Map.Entry<String,Optional<String>> getLinkedType(org.apache.maven.plugin.descriptor.Parameter parameter, boolean isShortType)

    • getXhtmlWithValidatedLinks

      String getXhtmlWithValidatedLinks(String xhtmlText, String context)

    • format

      private String format(String key, Object arg1)
      Convenience method.
      Parameters:
      key - not null
      arg1 - not null
      Returns:
      Localized, formatted text identified by key.
      See Also:

    • format

      private String format(String key, Object[] args)
      Looks up the value for key in the ResourceBundle, then formats that value for the specified Locale using args.
      Parameters:
      key - not null
      args - not null
      Returns:
      Localized, formatted text identified by key.

    • getI18nSection

      protected String getI18nSection()
      Specified by:
      getI18nSection in class AbstractPluginReportRenderer
      Returns:
      the key prefix to be used with every key. Is prepended by report..