org.apache.maven.plugin.jxr

Class JxrReportUtil

java.lang.Object

org.apache.maven.plugin.jxr.JxrReportUtil

public class JxrReportUtil
extends Object

Utility class for the jxr report.

Author:

Vincent Siveton

Constructor Summary

Constructors

Constructor and Description
JxrReportUtil()

Method Summary

Modifier and Type	Method and Description
protected static String	getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, String optionName, String defaultValue) Returns the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
protected static List<?>	getMavenJavadocPlugins(org.apache.maven.project.MavenProject project) Returns the plugin references for the javadoc plugin in a project.
protected static 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.

Methods inherited from class java.lang.Object

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

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 String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                         String optionName,
                                                         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 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

getStructure

protected static String getStructure(org.apache.maven.project.MavenProject project,
                                     boolean ignoreMissingSiteUrl)
                              throws 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:

IOException - if site url is missing