Package ball.maven.plugins.javadoc

Class AbstractJavadocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

ball.maven.plugins.javadoc.AbstractJavadocMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

GenerateJavadocMapMojo, GenerateOptionsFileMojo

public abstract class AbstractJavadocMojo
extends AbstractMojo

Abstract base class for javadoc Mojos.

Injected Field Summary

Annotation(s)	Field
@Inject	private MavenSession session
@Inject	private ArtifactHandlerManager manager
@Inject	private RepositorySystem system
@Inject	private ArtifactResolver resolver

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
AbstractJavadocMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected Stream<Dependency>	getDependencyManagementStream(MavenProject project)	Method to produce a Stream of MavenProject.getDependencies() and MavenProject.getDependencyManagement() Dependencies.
protected Set<URL>	getLinkSet(MavenProject project, boolean includeDependencyManagement)	Method to get the Set of Link URLs.
protected Map<Artifact,URL>	getResolvedOfflinelinkMap(MavenProject project, boolean includeDependencyManagement)	Method to get the Map of Offlinelink Artifacts to URLs.

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

AbstractJavadocMojo

public AbstractJavadocMojo()

Method Detail

getDependencyManagementStream

protected Stream<Dependency> getDependencyManagementStream(MavenProject project)

Method to produce a Stream of MavenProject.getDependencies() and MavenProject.getDependencyManagement() Dependencies.

Parameters:

project - The MavenProject.

Returns:

The Dependency Stream.

getLinkSet

protected Set<URL> getLinkSet(MavenProject project,
                              boolean includeDependencyManagement)

Method to get the Set of Link URLs.

Parameters:

project - The MavenProject.

includeDependencyManagement - Whether or not to include dependency management in the analysis.

Returns:

The Set of Link URLs.

getResolvedOfflinelinkMap

protected Map<Artifact,URL> getResolvedOfflinelinkMap(MavenProject project,
                                                            boolean includeDependencyManagement)

Method to get the Map of Offlinelink Artifacts to URLs.

Parameters:

project - The MavenProject.

includeDependencyManagement - Whether or not to include dependency management in the analysis.

Returns:

The Map of Offlinelink Artifacts to URLs.

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException