JavadocJar (Apache Maven Javadoc Plugin 2.10.4 API)

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

All Implemented Interfaces:

ContextEnabled, 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.html 990133 2016-06-07 18:27:57Z rfscholte $

- 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, 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
  
  Methods
  Modifier and Type Method and Description
  
  void execute()
  
  protected String 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, isAggregator, isTest, isValidJavadocLink, 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
`JavadocJar()`

Methods
Modifier and Type	Method and Description
`void`	`execute()`
`protected String`	`getClassifier()`

- Constructor Detail
  - JavadocJar
```
public JavadocJar()
```
- Method Detail
  - execute
```
public void execute()
             throws MojoExecutionException
```
    Throws:
    
    MojoExecutionException
  - getClassifier
```
protected String getClassifier()
```
    Returns:
    the wanted classifier, i.e. javadoc or test-javadoc

Class JavadocJar

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

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

Methods inherited from class java.lang.Object

Constructor Detail

JavadocJar

Method Detail

execute

getClassifier