org.apache.maven.plugins.javadoc

Class JavadocJar

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocJar

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorJavadocJar, TestJavadocJar

@Mojo(name="jar",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class JavadocJar
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

Version:

$Id: JavadocJar.java 1752018 2016-07-09 16:35:25Z rfscholte $

Field Summary

Fields

Modifier and Type	Field and 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 java.lang.String	classifier
private static java.lang.String[]	DEFAULT_EXCLUDES Excludes all processing files.
private static java.lang.String[]	DEFAULT_INCLUDES Includes all generated Javadoc files
private java.io.File	defaultManifestFile Path to the default MANIFEST file to use.
private java.io.File	destDir Deprecated.
private java.lang.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 java.lang.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 org.apache.maven.plugins.javadoc.AbstractJavadocMojo

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, 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 and Description
JavadocJar()

Method Summary

Modifier and Type	Method and Description
void	doExecute()
private java.io.File	generateArchive(java.io.File javadocFiles, java.lang.String jarFileName) Method that creates the jar file
protected java.lang.String	getClassifier()

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

buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, 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

Field Detail

DEFAULT_INCLUDES

private static final java.lang.String[] DEFAULT_INCLUDES

Includes all generated Javadoc files

DEFAULT_EXCLUDES

private static final java.lang.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

@Component
private org.apache.maven.project.MavenProjectHelper projectHelper

Used for attaching the artifact in the project.

jarArchiver

@Component(role=org.codehaus.plexus.archiver.Archiver.class,
           hint="jar")
private org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver

The Jar archiver.

Since:

2.5

destDir

@Deprecated
 @Parameter(property="destDir")
private java.io.File destDir

Deprecated.

Specifies the destination directory where javadoc saves the generated HTML files. See d.

jarOutputDirectory

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

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

finalName

@Parameter(property="project.build.finalName")
private java.lang.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 java.io.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 java.lang.String classifier

Since:

2.10

Constructor Detail

JavadocJar

public JavadocJar()

Method Detail

doExecute

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

Specified by:

doExecute in class AbstractJavadocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getClassifier

protected java.lang.String getClassifier()

Returns:

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

generateArchive

private java.io.File generateArchive(java.io.File javadocFiles,
                                     java.lang.String jarFileName)
                              throws org.codehaus.plexus.archiver.ArchiverException,
                                     java.io.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

java.io.IOException - IOException