Class JavadocJarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocJarMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorJavadocJarMojo, TestJavadocJarMojo

@Mojo(name="jar",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class JavadocJarMojo
extends AbstractJavadocMojo

Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.maven.archiver.MavenArchiveConfiguration	archive	The archive configuration to use.
private boolean	attach	Specifies whether to attach the generated artifact to the project helper.
private String	classifier
private static final String[]	DEFAULT_EXCLUDES	Excludes all processing files.
private static final String[]	DEFAULT_INCLUDES	Includes all generated Javadoc files
private File	defaultManifestFile	Path to the default MANIFEST file to use.
private boolean	detectOfflineLinks	Detect the links for all modules defined in the project.
private String	finalName	Specifies the filename that will be used for the generated jar file.
private org.codehaus.plexus.archiver.jar.JarArchiver	jarArchiver	The Jar archiver.
private String	jarOutputDirectory	Specifies the directory where the generated jar file will be put.
private org.apache.maven.project.MavenProjectHelper	projectHelper	Used for attaching the artifact in the project.
private boolean	useDefaultManifestFile	Set this to true to enable the use of the defaultManifestFile.

Fields inherited from class AbstractJavadocMojo

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, locationManager, 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

JavadocJarMojo(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 void	doExecute()
private File	generateArchive(File javadocFiles, String jarFileName)	Method that creates the jar file
protected String	getClassifier()
boolean	isDetectOfflineLinks()

Methods inherited from class AbstractJavadocMojo

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

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_INCLUDES

private static final String[] DEFAULT_INCLUDES

Includes all generated Javadoc files

DEFAULT_EXCLUDES

private static final String[] DEFAULT_EXCLUDES

Excludes all processing files.

See Also:

• AbstractJavadocMojo.DEBUG_JAVADOC_SCRIPT_NAME
• AbstractJavadocMojo.OPTIONS_FILE_NAME
• AbstractJavadocMojo.PACKAGES_FILE_NAME
• AbstractJavadocMojo.ARGFILE_FILE_NAME
• AbstractJavadocMojo.FILES_FILE_NAME

projectHelper

private org.apache.maven.project.MavenProjectHelper projectHelper

Used for attaching the artifact in the project.

jarArchiver

private org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver

The Jar archiver.

Since:

2.5

jarOutputDirectory

@Parameter(property="project.build.directory")
private String jarOutputDirectory

Specifies the directory where the generated jar file will be put.

finalName

@Parameter(property="project.build.finalName")
private String finalName

Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.

attach

@Parameter(property="attach",
           defaultValue="true")
private boolean attach

Specifies whether to attach the generated artifact to the project helper.

archive

@Parameter
private org.apache.maven.archiver.MavenArchiveConfiguration archive

The archive configuration to use. See Maven Archiver Reference.

Since:

2.5

defaultManifestFile

@Parameter(defaultValue="${project.build.outputDirectory}/META-INF/MANIFEST.MF",
           required=true,
           readonly=true)
private File defaultManifestFile

Path to the default MANIFEST file to use. It will be used if useDefaultManifestFile is set to true.

Since:

2.5

useDefaultManifestFile

@Parameter(defaultValue="false")
private boolean useDefaultManifestFile

Set this to true to enable the use of the defaultManifestFile.

Since:

2.5

classifier

@Parameter(property="maven.javadoc.classifier",
           defaultValue="javadoc",
           required=true)
private String classifier

Since:

2.10

detectOfflineLinks

@Parameter(property="detectOfflineLinks",
           defaultValue="false")
private boolean detectOfflineLinks

Detect the links for all modules defined in the project.
If reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project's URLs. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:
The added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs
The added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs

Since:

2.6

See Also:

• AbstractJavadocMojo.offlineLinks

Constructor Details

JavadocJarMojo

@Inject
public JavadocJarMojo(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

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Specified by:

doExecute in class AbstractJavadocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassifier

protected String getClassifier()

Returns:

the wanted classifier, i.e. javadoc or test-javadoc

generateArchive

private File generateArchive(File javadocFiles,
 String jarFileName)
                      throws org.codehaus.plexus.archiver.ArchiverException,
IOException

Method that creates the jar file

Parameters:

javadocFiles - the directory where the generated jar file will be put

jarFileName - the filename of the generated jar file

Returns:

a File object that contains the generated jar file

Throws:

org.codehaus.plexus.archiver.ArchiverException - ArchiverException

IOException - IOException

isDetectOfflineLinks

public boolean isDetectOfflineLinks()

Overrides:

isDetectOfflineLinks in class AbstractJavadocMojo