AggregatorJavadocJar (Apache Maven Javadoc Plugin 2.9.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugin.javadoc.AbstractJavadocMojo
  - - org.apache.maven.plugin.javadoc.JavadocJar
    - - org.apache.maven.plugin.javadoc.AggregatorJavadocJar

All Implemented Interfaces:

ContextEnabled, Mojo
```
@Mojo(name="aggregate-jar",
      defaultPhase=PACKAGE,
      aggregator=true,
      requiresDependencyResolution=COMPILE)
public class AggregatorJavadocJar
extends JavadocJar
```
Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.

Since:

2.6

Version:

$Id: AggregatorJavadocJar.html 867304 2013-06-25 01:20:34Z olamy $

- 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, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  AggregatorJavadocJar()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  protected boolean isAggregator()
  Indicates whether this goal is flagged with @aggregator.
  - Methods inherited from class org.apache.maven.plugin.javadoc.JavadocJar
    execute, getClassifier
  - Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
    buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, failOnError, getAttachmentClassifier, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, logError, resolveDependency
  - 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

Constructors
Constructor and Description
`AggregatorJavadocJar()`

Methods
Modifier and Type	Method and Description
`protected boolean`	`isAggregator()` Indicates whether this goal is flagged with `@aggregator`.

- Constructor Detail
  - AggregatorJavadocJar
```
public AggregatorJavadocJar()
```
- Method Detail
  - isAggregator
```
protected boolean isAggregator()
```
    Description copied from class: AbstractJavadocMojo
    
    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

Class AggregatorJavadocJar

Field Summary

Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.javadoc.JavadocJar

Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

AggregatorJavadocJar

Method Detail

isAggregator