Package ball.maven.plugins.javadoc

Class GenerateJavadocMapMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ball.maven.plugins.javadoc.AbstractJavadocMojo

ball.maven.plugins.javadoc.GenerateJavadocMapMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="generate-javadoc-map",
      requiresDependencyResolution=RUNTIME,
      requiresProject=true)
public class GenerateJavadocMapMojo
extends AbstractJavadocMojo

Mojo to generate offline javadoc map. For each documented package, generate the following key/value pairs: package/Javadoc Root URL, package-module / Module (e.g., java.base), and package-artifact / groupId:artifactId. The package-module and package-artifact key/values are absent if no module or artifact respectively are specified.

Injected Field Summary

Annotation(s)	Field
@Inject	private MavenProject project

Maven Plugin Parameter Summary

	Field	Default	Property	Required	Editable	Description
	private boolean includeDependencyManagement	true	${includeDependencyManagement}	false	true
AbstractJavadocMojo	private Link[] links			false	true
AbstractJavadocMojo	private Offlinelink[] offlinelinks			false	true
	private File outputDirectory	${project.build.directory}	${outputDirectory}	false	true
	private String outputFileName	javadoc-map.properties	${outputFileName}	false	true
AbstractJavadocMojo	private boolean skip	false	${maven.javadoc.skip}	false	true

Bean Property Summary

Name	Mode	Type	isHidden	isBound	isConstrained
links	R	Link[]	false	false	false
log	RW	Log	false	false	false
manager	R	ArtifactHandlerManager	false	false	false
offlinelinks	R	Offlinelink[]	false	false	false
pluginContext	RW	Map	false	false	false
resolver	R	ArtifactResolver	false	false	false
session	R	MavenSession	false	false	false
skip	R	boolean	false	false	false
system	R	RepositorySystem	false	false	false

Author:

Allen D. Ball

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateJavadocMapMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class ball.maven.plugins.javadoc.AbstractJavadocMojo

getDependencyManagementStream, getLinkSet, getResolvedOfflinelinkMap

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 Detail

GenerateJavadocMapMojo

public GenerateJavadocMapMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:

execute in interface Mojo

Overrides:

execute in class AbstractJavadocMojo

Throws:

MojoExecutionException

MojoFailureException