org.apache.maven.plugin.javadoc
Class AbstractJavadocMojo

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

public abstract class AbstractJavadocMojo
extends org.apache.maven.plugin.AbstractMojo

Base class with majority of Javadoc functionality.

Author:
Brett Porter

Field Summary
protected  boolean aggregate
          Whether to build an aggregated report at the root, or build individual reports.
protected  java.io.File outputDirectory
          Specifies the destination directory where javadoc saves the generated HTML files.
protected  org.apache.maven.project.MavenProject project
           
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractJavadocMojo()
           
 
Method Summary
protected  boolean canGenerateReport(java.util.List files)
           
protected  void executeReport(java.util.Locale locale)
           
protected  java.util.List getFiles(java.util.List sourcePaths)
           
protected  java.lang.String getOutputDirectory()
           
protected  java.util.List getSourcePaths()
           
 
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
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

outputDirectory

protected java.io.File outputDirectory
Specifies the destination directory where javadoc saves the generated HTML files. See d.


project

protected org.apache.maven.project.MavenProject project

aggregate

protected boolean aggregate
Whether to build an aggregated report at the root, or build individual reports.

Constructor Detail

AbstractJavadocMojo

public AbstractJavadocMojo()
Method Detail

getOutputDirectory

protected java.lang.String getOutputDirectory()
See Also:
AbstractMavenReport.getOutputDirectory()

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException
Throws:
org.apache.maven.reporting.MavenReportException
See Also:
AbstractMavenReport.executeReport(java.util.Locale)

getFiles

protected java.util.List getFiles(java.util.List sourcePaths)

getSourcePaths

protected java.util.List getSourcePaths()

canGenerateReport

protected boolean canGenerateReport(java.util.List files)


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