Package org.apache.maven.plugins.javadoc

Class AggregatorTestJavadocJarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocJarMojo

org.apache.maven.plugins.javadoc.TestJavadocJarMojo

org.apache.maven.plugins.javadoc.AggregatorTestJavadocJarMojo

All Implemented Interfaces:

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

@Mojo(name="test-aggregate-jar",
      defaultPhase=PACKAGE,
      aggregator=true,
      requiresDependencyResolution=TEST)
@Execute(phase=TEST_COMPILE)
public class AggregatorTestJavadocJarMojo
extends TestJavadocJarMojo

Bundles the Javadoc documentation for Java Test 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, mojoExecution, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, reactorProjects, session, siteTool, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

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

ROLE

Constructor Summary

Constructors

Constructor

Description

AggregatorTestJavadocJarMojo(org.apache.maven.project.MavenProjectHelper projectHelper, org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver, org.apache.maven.doxia.tools.SiteTool siteTool, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, ResourceResolver resourceResolver, org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.apache.maven.project.ProjectBuilder mavenProjectBuilder, org.apache.maven.toolchain.ToolchainManager toolchainManager)

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.TestJavadocJarMojo

configureDependencySourceResolution, getClassifier, getDependencyScopeFilter, getDoctitle, getExecutionProjectSourceRoots, getJavadocDirectory, getOverview, getProjectBuildOutputDirs, getProjectSourceRoots, getWindowtitle, isTest

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

doExecute, isDetectOfflineLinks

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

buildJavadocOptions, canGenerateReport, execute, executeReport, failOnError, getAttachmentClassifier, getClassesFile, getDefaultJavadocApiLink, getDependencySourcePaths, getDoclint, getFiles, getJavadocOptionsFile, getOutputDirectory, getPluginReportOutputDirectory, getProject, getReactorProjects, getSourcePaths, getToolchain, isSkippedJavadoc, isSkippedModule, 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

AggregatorTestJavadocJarMojo

@Inject
public AggregatorTestJavadocJarMojo(org.apache.maven.project.MavenProjectHelper projectHelper,
 org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver,
 org.apache.maven.doxia.tools.SiteTool siteTool,
 org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager,
 ResourceResolver resourceResolver,
 org.eclipse.aether.RepositorySystem repoSystem,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.apache.maven.project.ProjectBuilder mavenProjectBuilder,
 org.apache.maven.toolchain.ToolchainManager toolchainManager)

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