org.apache.maven.plugin.javadoc
Class JavadocReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          extended by org.apache.maven.plugin.javadoc.JavadocReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
AggregatorJavadocReport, TestJavadocReport

public class JavadocReport
extends AbstractJavadocMojo
implements org.apache.maven.reporting.MavenReport

Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.

Since:
2.0
Version:
$Id: JavadocReport.html 829394 2012-08-19 17:31:42Z hboutemy $
Author:
Emmanuel Venisse, Vincent Siveton
See Also:
Javadoc Tool, Javadoc Options
Is defined to be executed in:
phase:
generate-sources
Is defined by the goal name:
javadoc

Field Summary
 
Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
aggregate, ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, FILES_FILE_NAME, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, skip, useStandardDocletOptions
 
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
 
Constructor Summary
JavadocReport()
           
  isAggregator hasSourceFiles isRootProject Generate Report True True True True True True False False True False True False True False False False False True True True False True False True False False True False False False False False
Method Summary
 boolean canGenerateReport()
          
The logic is the following:
 void execute()
          
 void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)
          
 java.lang.String getCategoryName()
          
 java.lang.String getDescription(java.util.Locale locale)
          
 java.lang.String getName(java.util.Locale locale)
          
 java.lang.String getOutputName()
          
 java.io.File getReportOutputDirectory()
          
protected  boolean isAggregator()
          Indicates whether this goal is flagged with @aggregator.
 boolean isExternalReport()
          
 void setDestDir(java.lang.String destDir)
           
 void setReportOutputDirectory(java.io.File reportOutputDirectory)
          Method to set the directory where the generated reports will be put
 
Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
canGenerateReport, executeReport, getCompileArtifacts, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getOutputDirectory, getOverview, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle
 
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
 

Constructor Detail

JavadocReport

public JavadocReport()
Method Detail

getName

public java.lang.String getName(java.util.Locale locale)

Specified by:
getName in interface org.apache.maven.reporting.MavenReport

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Specified by:
getDescription in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
                     java.util.Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:
generate in interface org.apache.maven.reporting.MavenReport
Throws:
org.apache.maven.reporting.MavenReportException

getOutputName

public java.lang.String getOutputName()

Specified by:
getOutputName in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:
isExternalReport in interface org.apache.maven.reporting.MavenReport

canGenerateReport

public boolean canGenerateReport()

The logic is the following:
isAggregator hasSourceFiles isRootProject Generate Report
True True True True
True True False False
True False True False
True False False False
False True True True
False True False True
False False True False
False False False False

Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport

getCategoryName

public java.lang.String getCategoryName()

Specified by:
getCategoryName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()

Specified by:
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)
Method to set the directory where the generated reports will be put

Specified by:
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
Parameters:
reportOutputDirectory - the directory file to be set

setDestDir

public void setDestDir(java.lang.String destDir)

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:
execute in interface org.apache.maven.plugin.Mojo
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException

isAggregator

protected boolean isAggregator()
Indicates whether this goal is flagged with @aggregator.

Overrides:
isAggregator in class AbstractJavadocMojo
Returns:
true if the goal is designed as an aggregator, false otherwise.
See Also:
AggregatorJavadocReport, AggregatorTestJavadocReport


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.