Package org.apache.maven.plugins.javadoc

Class AbstractFixJavadocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

FixJavadocMojo, TestFixJavadocMojo

public abstract class AbstractFixJavadocMojo
extends org.apache.maven.plugin.AbstractMojo

Abstract class to fix Javadoc documentation and tags in source files.

Since:

2.6

Author:

Vincent Siveton

See Also:

• Where Tags Can Be Used

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_VERSION_VALUE	Default version value.
protected boolean	ignoreClirr	Flag to ignore or not Clirr.
static final String	JAVA_FILES	Java Files Pattern.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractFixJavadocMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected String	getArtifactType(org.apache.maven.project.MavenProject p)
protected List<String>	getCompileClasspathElements(org.apache.maven.project.MavenProject p)
protected static String	getJavaMethodAsString(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)
protected final org.apache.maven.project.MavenProject	getProject()
protected List<String>	getProjectSourceRoots(org.apache.maven.project.MavenProject p)

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 Details

JAVA_FILES

public static final String JAVA_FILES

Java Files Pattern.

See Also:

• Constant Field Values

DEFAULT_VERSION_VALUE

public static final String DEFAULT_VERSION_VALUE

Default version value.

See Also:

• Constant Field Values

ignoreClirr

@Parameter(property="ignoreClirr",
           defaultValue="false")
protected boolean ignoreClirr

Flag to ignore or not Clirr.

Constructor Details

AbstractFixJavadocMojo

public AbstractFixJavadocMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getProject

protected final org.apache.maven.project.MavenProject getProject()

getArtifactType

protected String getArtifactType(org.apache.maven.project.MavenProject p)

Parameters:

p - not null maven project.

Returns:

the artifact type.

getProjectSourceRoots

protected List<String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)

Parameters:

p - not null maven project.

Returns:

the list of source paths for the given project.

getCompileClasspathElements

protected List<String> getCompileClasspathElements(org.apache.maven.project.MavenProject p)
                                            throws org.apache.maven.artifact.DependencyResolutionRequiredException

Parameters:

p - not null

Returns:

the compile classpath elements

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException - if any

getJavaMethodAsString

protected static String getJavaMethodAsString(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)

Parameters:

javaExecutable - not null

Returns:

the fully qualify name of javaMethod with signature