org.apache.maven.plugin.javadoc
Class AbstractFixJavadocMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractFixJavadocMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

FixJavadocMojo, TestFixJavadocMojo

public abstract class AbstractFixJavadocMojo
extends AbstractMojo

Abstract class to fix Javadoc documentation and tags in source files.
See Where Tags Can Be Used.

Since:

2.6

Version:

$Id: AbstractFixJavadocMojo.java 1385123 2012-09-15 16:47:26Z hboutemy $

Author:

Vincent Siveton

Field Summary

static String	DEFAULT_VERSION_VALUE
protected boolean	ignoreClirr Flag to ignore or not Clirr.
static String	JAVA_FILES

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

ROLE

Constructor Summary

AbstractFixJavadocMojo()

Method Summary

void	execute()
protected String	getArtifactType(MavenProject p)
protected List<String>	getCompileClasspathElements(MavenProject p)
protected static String	getJavaMethodAsString(JavaMethod javaMethod)
protected List<String>	getProjectSourceRoots(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 Detail

JAVA_FILES

public static final String JAVA_FILES

See Also:

Constant Field Values

DEFAULT_VERSION_VALUE

public static final String DEFAULT_VERSION_VALUE

See Also:

Constant Field Values

ignoreClirr

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

Flag to ignore or not Clirr.

Constructor Detail

AbstractFixJavadocMojo

public AbstractFixJavadocMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

getArtifactType

protected String getArtifactType(MavenProject p)

Parameters:

p - not null maven project.

Returns:

the artifact type.

getProjectSourceRoots

protected List<String> getProjectSourceRoots(MavenProject p)

Parameters:

p - not null maven project.

Returns:

the list of source paths for the given project.

getCompileClasspathElements

protected List<String> getCompileClasspathElements(MavenProject p)
                                            throws DependencyResolutionRequiredException

Parameters:

p - not null

Returns:

the compile classpath elements

Throws:

DependencyResolutionRequiredException - if any

getJavaMethodAsString

protected static String getJavaMethodAsString(JavaMethod javaMethod)

Parameters:

javaMethod - not null

Returns:

the fully qualify name of javaMethod with signature