org.apache.maven.plugin.jxr
Class JxrReportUtil

java.lang.Object
  extended by org.apache.maven.plugin.jxr.JxrReportUtil

public class JxrReportUtil
extends Object

Utility class for the jxr report.

Version:
$Id: JxrReportUtil.java 692686 2008-09-06 17:13:41Z hboutemy $
Author:
Vincent Siveton

Constructor Summary
JxrReportUtil()
           
 
Method Summary
protected static String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, String optionName, String defaultValue)
          Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
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.
 
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

getMavenJavadocPluginBasicOption

protected static String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                         String optionName,
                                                         String defaultValue)
                                                  throws IOException
Return 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.
Throws:
IOException - if any

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 -
ignoreMissingSiteUrl -
Returns:
the structure relative path
Throws:
IOException - if any
See Also:
org.apache.maven.plugins.site.SiteStageMojo#getStructure( MavenProject project, boolean ignoreMissingSiteUrl )


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.