org.apache.maven.plugin.jxr
Class JxrTestReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugin.jxr.AbstractJxrReport
org.apache.maven.plugin.jxr.JxrTestReport
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
public class JxrTestReport
- extends AbstractJxrReport
Creates an html-based, cross referenced version of Java source code
for a project's test sources.
- Version:
- $Id: JxrTestReport.java 543883 2007-06-03 11:56:01Z vsiveton $
- Author:
- Fabrice Bellingard, Brett Porter
- Is defined by the goal name:
- test-jxr
Fields inherited from interface org.apache.maven.reporting.MavenReport |
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE |
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
Method Summary |
java.lang.String |
getDescription(java.util.Locale locale)
|
protected java.lang.String |
getDestinationDirectory()
Abstract method that returns the target directory where the generated JXR reports will be put. |
protected java.io.File |
getJavadocDir()
Abstract method that returns the directory of the javadoc files. |
java.lang.String |
getName(java.util.Locale locale)
|
java.lang.String |
getOutputName()
|
protected java.util.List |
getSourceRoots()
Abstract method that returns the specified source directories that will be included in the JXR report generation. |
protected java.util.List |
getSourceRoots(org.apache.maven.project.MavenProject project)
Abstract method that returns the compile source directories of the specified project that will be included in the
JXR report generation |
void |
setReportOutputDirectory(java.io.File reportOutputDirectory)
|
Methods inherited from class org.apache.maven.plugin.jxr.AbstractJxrReport |
canGenerateReport, canGenerateReport, constructSourceDirs, executeReport, getBundle, getOutputDirectory, getOutputEncoding, getProject, getSiteRenderer, init, isExternalReport, pruneSourceDirs |
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JxrTestReport
public JxrTestReport()
getSourceRoots
protected java.util.List getSourceRoots()
- Description copied from class:
AbstractJxrReport
- Abstract method that returns the specified source directories that will be included in the JXR report generation.
- Specified by:
getSourceRoots
in class AbstractJxrReport
- Returns:
- a List of the source directories
- See Also:
AbstractJxrReport.getSourceRoots()
getSourceRoots
protected java.util.List getSourceRoots(org.apache.maven.project.MavenProject project)
- Description copied from class:
AbstractJxrReport
- Abstract method that returns the compile source directories of the specified project that will be included in the
JXR report generation
- Specified by:
getSourceRoots
in class AbstractJxrReport
- Parameters:
project
- the MavenProject where the JXR report plugin will be executed
- Returns:
- a List of the source directories
- See Also:
AbstractJxrReport.getSourceRoots(org.apache.maven.project.MavenProject)
getDestinationDirectory
protected java.lang.String getDestinationDirectory()
- Description copied from class:
AbstractJxrReport
- Abstract method that returns the target directory where the generated JXR reports will be put.
- Specified by:
getDestinationDirectory
in class AbstractJxrReport
- Returns:
- a String that contains the target directory name
- See Also:
AbstractJxrReport.getDestinationDirectory()
getDescription
public java.lang.String getDescription(java.util.Locale locale)
- See Also:
MavenReport.getDescription(java.util.Locale)
getName
public java.lang.String getName(java.util.Locale locale)
- See Also:
MavenReport.getName(java.util.Locale)
getOutputName
public java.lang.String getOutputName()
- See Also:
MavenReport.getOutputName()
getJavadocDir
protected java.io.File getJavadocDir()
- Description copied from class:
AbstractJxrReport
- Abstract method that returns the directory of the javadoc files.
- Specified by:
getJavadocDir
in class AbstractJxrReport
- Returns:
- a File for the directory of the javadocs
- See Also:
AbstractJxrReport.getJavadocDir()
setReportOutputDirectory
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
- Specified by:
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
- Overrides:
setReportOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
- See Also:
AbstractMavenReport.setReportOutputDirectory(java.io.File)
Copyright © 2005-2010 The Apache Software Foundation. All Rights Reserved.