Package org.apache.maven.plugin.jxr

Class JxrReportUtil

  • public class JxrReportUtil
extends java.lang.Object
    Utility class for the jxr report.

    • Constructor Summary

      Constructors 
      Constructor Description
      JxrReportUtil()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static java.lang.String getMavenJavadocPluginBasicOption​(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
      Returns the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
      protected static java.util.List<?> getMavenJavadocPlugins​(org.apache.maven.project.MavenProject project)
      Returns the plugin references for the javadoc plugin in a project.
      protected static java.lang.String getStructure​(org.apache.maven.project.MavenProject project, boolean ignoreMissingSiteUrl)
      Generates the site structure using the project hierarchy (project and its modules) or using the distributionManagement elements from the pom.xml.
      protected static boolean isJavadocAggregated​(org.apache.maven.project.MavenProject project)
      Determine if javadoc is aggregated in this project, paying attention to both TODO: take cognizance of javadoc versus test-javadoc the old parameter and the new mojo.
      private static boolean isReportPluginJavaDocPlugin​(java.lang.String pluginArtifactId, org.apache.maven.model.ReportPlugin reportPlugin)  
      private static boolean isReportPluginMavenJavadoc​(java.lang.String pluginArtifactId, org.apache.maven.model.Plugin plugin)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MAVEN_JAVADOC_PLUGIN_GROUP_ID

        private static final java.lang.String MAVEN_JAVADOC_PLUGIN_GROUP_ID
        See Also:
        Constant Field Values

      • MAVEN_JAVADOC_PLUGIN_ARTIFACT_ID

        private static final java.lang.String MAVEN_JAVADOC_PLUGIN_ARTIFACT_ID
        See Also:
        Constant Field Values

    • Constructor Detail

      • JxrReportUtil

        public JxrReportUtil()

    • Method Detail

      • isJavadocAggregated

        protected static boolean isJavadocAggregated​(org.apache.maven.project.MavenProject project)
        Determine if javadoc is aggregated in this project, paying attention to both TODO: take cognizance of javadoc versus test-javadoc the old parameter and the new mojo.
        Parameters:
        project - the Maven project
        Returns:
        if javadoc is aggregated, false otherwise

      • getMavenJavadocPluginBasicOption

        protected static java.lang.String getMavenJavadocPluginBasicOption​(org.apache.maven.project.MavenProject project,
                                                                   java.lang.String optionName,
                                                                   java.lang.String defaultValue)
        Returns the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
        Parameters:
        project - not null
        optionName - the option name wanted
        defaultValue - a default value
        Returns:
        the value for the option name or the default value. Could be null if not found.

      • getMavenJavadocPlugins

        protected static java.util.List<?> getMavenJavadocPlugins​(org.apache.maven.project.MavenProject project)
        Returns the plugin references for the javadoc plugin in a project.
        Parameters:
        project - Maven project
        Returns:
        list of Javadoc plugins

      • isReportPluginMavenJavadoc

        private static boolean isReportPluginMavenJavadoc​(java.lang.String pluginArtifactId,
                                                  org.apache.maven.model.Plugin plugin)

      • isReportPluginJavaDocPlugin

        private static boolean isReportPluginJavaDocPlugin​(java.lang.String pluginArtifactId,
                                                   org.apache.maven.model.ReportPlugin reportPlugin)

      • getStructure

        protected static java.lang.String getStructure​(org.apache.maven.project.MavenProject project,
                                               boolean ignoreMissingSiteUrl)
                                        throws java.io.IOException
        Generates the site structure using the project hierarchy (project and its modules) or using the distributionManagement elements from the pom.xml.
        Parameters:
        project - the Maven project
        ignoreMissingSiteUrl - whether missing site url in distribution management of the POM should be ignored
        Returns:
        the structure relative path
        Throws:
        java.io.IOException - if site url is missing