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

Class GoalRenderer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.apache.maven.plugin.descriptor.MojoDescriptor descriptor  
      private boolean disableInternalJavadocLinkValidation  
      private static java.util.regex.Pattern HTML_LINK_PATTERN
      Regular expression matching an XHTML link with group 1 = link target, group 2 = link label.
      private org.apache.maven.plugin.logging.Log log  
      private java.io.File reportOutputDirectory
      The directory where the generated site is written.

      • Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

        sink

    • Constructor Summary

      Constructors 
      Constructor Description
      GoalRenderer​(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, java.util.Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.plugin.descriptor.MojoDescriptor descriptor, java.io.File reportOutputDirectory, boolean disableInternalJavadocLinkValidation, org.apache.maven.plugin.logging.Log log)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.util.List<org.apache.maven.plugin.descriptor.Parameter> filterParameters​(java.util.Collection<org.apache.maven.plugin.descriptor.Parameter> parameterList)
      Filter parameters to only retain those which must be documented, i.e.
      private java.lang.String format​(java.lang.String key, java.lang.Object arg1)
      Convenience method.
      private java.lang.String format​(java.lang.String key, java.lang.Object[] args)
      Looks up the value for key in the ResourceBundle, then formats that value for the specified Locale using args.
      protected java.lang.String getI18nSection()  
      private java.util.Map.Entry<java.lang.String,​java.util.Optional<java.lang.String>> getLinkedType​(org.apache.maven.plugin.descriptor.Parameter parameter, boolean isShortType)  
      private static java.lang.String getPropertyFromExpression​(java.lang.String expression)  
      (package private) static java.lang.String getShortType​(java.lang.String type)  
      private static java.lang.String getShortTypeOfSimpleType​(java.lang.String type)  
      private static java.lang.String getShortTypeOfTypeArgument​(java.lang.String type)  
      java.lang.String getTitle()  
      (package private) java.lang.String getXhtmlWithValidatedLinks​(java.lang.String xhtmlText, java.lang.String context)  
      private void renderAttribute​(boolean condition, java.lang.String attributeKey)  
      private void renderAttribute​(boolean condition, java.lang.String attributeKey, java.util.Optional<java.lang.String> codeArgument)  
      private void renderAttribute​(java.lang.String conditionAndCodeArgument, java.lang.String attributeKey)  
      private void renderAttributes()  
      protected void renderBody()  
      private void renderDeprecatedParameterDescription​(java.lang.String deprecated, java.lang.String context)  
      private void renderDescription​(java.lang.String prefixKey, java.lang.String description, boolean isHtmlMarkup)
      A description consists of a term/prefix and the actual description text
      private void renderDescriptionPrefix​(java.lang.String prefixKey)  
      private void renderDetail​(java.lang.String param, java.lang.String value)  
      private void renderDetail​(java.lang.String param, java.lang.String value, java.util.Optional<java.lang.String> valueLink)  
      private void renderParameterDetails​(java.util.Iterator<org.apache.maven.plugin.descriptor.Parameter> parameters)  
      private void renderParameterOverviewTable​(java.lang.String title, java.util.Iterator<org.apache.maven.plugin.descriptor.Parameter> parameters)  
      private void renderParameterOverviewTableRow​(org.apache.maven.plugin.descriptor.Parameter parameter)  
      private void renderReportNotice()  
      private void renderTableCellDetail​(java.lang.String nameKey, java.lang.String value)  
      private void renderTableCellWithCode​(java.lang.String text)  
      private void renderTableCellWithCode​(java.lang.String text, java.util.Optional<java.lang.String> link)  

      • Methods inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

        createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, startSection, startSection, startTable, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimSource, verbatimText

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • HTML_LINK_PATTERN

        private static final java.util.regex.Pattern HTML_LINK_PATTERN
        Regular expression matching an XHTML link with group 1 = link target, group 2 = link label.

      • reportOutputDirectory

        private final java.io.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 Detail

      • GoalRenderer

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

    • Method Detail

      • getTitle

        public java.lang.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 java.util.List<org.apache.maven.plugin.descriptor.Parameter> filterParameters​(java.util.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​(java.lang.String prefixKey,
                               java.lang.String description,
                               boolean isHtmlMarkup)
        A description consists of a term/prefix and the actual description text

      • renderDescriptionPrefix

        private void renderDescriptionPrefix​(java.lang.String prefixKey)

      • renderAttributes

        private void renderAttributes()

      • renderAttribute

        private void renderAttribute​(boolean condition,
                             java.lang.String attributeKey)

      • renderAttribute

        private void renderAttribute​(java.lang.String conditionAndCodeArgument,
                             java.lang.String attributeKey)

      • renderAttribute

        private void renderAttribute​(boolean condition,
                             java.lang.String attributeKey,
                             java.util.Optional<java.lang.String> codeArgument)

      • renderParameterOverviewTable

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

      • renderTableCellWithCode

        private void renderTableCellWithCode​(java.lang.String text)

      • renderTableCellWithCode

        private void renderTableCellWithCode​(java.lang.String text,
                                     java.util.Optional<java.lang.String> link)

      • renderParameterOverviewTableRow

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

      • renderParameterDetails

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

      • renderDeprecatedParameterDescription

        private void renderDeprecatedParameterDescription​(java.lang.String deprecated,
                                                  java.lang.String context)

      • renderTableCellDetail

        private void renderTableCellDetail​(java.lang.String nameKey,
                                   java.lang.String value)

      • renderDetail

        private void renderDetail​(java.lang.String param,
                          java.lang.String value)

      • renderDetail

        private void renderDetail​(java.lang.String param,
                          java.lang.String value,
                          java.util.Optional<java.lang.String> valueLink)

      • getPropertyFromExpression

        private static java.lang.String getPropertyFromExpression​(java.lang.String expression)

      • getShortType

        static java.lang.String getShortType​(java.lang.String type)

      • getShortTypeOfTypeArgument

        private static java.lang.String getShortTypeOfTypeArgument​(java.lang.String type)

      • getShortTypeOfSimpleType

        private static java.lang.String getShortTypeOfSimpleType​(java.lang.String type)

      • getLinkedType

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

      • getXhtmlWithValidatedLinks

        java.lang.String getXhtmlWithValidatedLinks​(java.lang.String xhtmlText,
                                            java.lang.String context)

      • format

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

      • format

        private java.lang.String format​(java.lang.String key,
                                java.lang.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.