org.apache.maven.plugin.jxr
Class JxrReportUtil
java.lang.Object
org.apache.maven.plugin.jxr.JxrReportUtil
public class JxrReportUtil
- extends java.lang.Object
Utility class for the jxr report.
- Version:
- $Id: JxrReportUtil.java 692686 2008-09-06 17:13:41Z hboutemy $
- Author:
- Vincent Siveton
Method Summary |
protected static java.lang.String |
getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
java.lang.String optionName,
java.lang.String defaultValue)
Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin. |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JxrReportUtil
public JxrReportUtil()
getMavenJavadocPluginBasicOption
protected static java.lang.String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
java.lang.String optionName,
java.lang.String defaultValue)
throws java.io.IOException
- Return the
optionName
value defined in a project for the "maven-javadoc-plugin" plugin.
- Parameters:
project
- not nulloptionName
- the option name wanteddefaultValue
- a default value
- Returns:
- the value for the option name or the default value. Could be null if not found.
- Throws:
java.io.IOException
- if any
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
- ignoreMissingSiteUrl
-
- Returns:
- the structure relative path
- Throws:
java.io.IOException
- if any- See Also:
org.apache.maven.plugins.site.SiteStageMojo#getStructure( MavenProject project, boolean ignoreMissingSiteUrl )
Copyright © 2005-2010 The Apache Software Foundation. All Rights Reserved.