Package org.apache.maven.plugins.javadoc

Class AggregatorJavadocJar

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocJar

org.apache.maven.plugins.javadoc.AggregatorJavadocJar

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="aggregate-jar",
      defaultPhase=PACKAGE,
      aggregator=true,
      requiresDependencyResolution=COMPILE)
@Execute(phase=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 version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project.

Since:

2.6

Field Summary

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

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AggregatorJavadocJar()

Method Summary

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

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

doExecute, getClassifier

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

buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getClassesFile, getDefaultJavadocApiLink, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter

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 Details

AggregatorJavadocJar

public AggregatorJavadocJar()

Method Details

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