Class 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.
    See Where Tags Can Be Used.
    Since:
    2.6
    Version:
    $Id: AbstractFixJavadocMojo.java 1801354 2017-07-09 08:49:46Z rfscholte $
    Author:
    Vincent Siveton
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_VERSION_VALUE
      Default version value.
      protected boolean ignoreClirr
      Flag to ignore or not Clirr.
      static java.lang.String JAVA_FILES
      Java Files Pattern.
      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()
      protected java.lang.String getArtifactType​(org.apache.maven.project.MavenProject p)  
      protected java.util.List<java.lang.String> getCompileClasspathElements​(org.apache.maven.project.MavenProject p)  
      protected static java.lang.String getJavaMethodAsString​(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)  
      protected java.util.List<java.lang.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 Detail

      • JAVA_FILES

        public static final java.lang.String JAVA_FILES
        Java Files Pattern.
        See Also:
        Constant Field Values
      • DEFAULT_VERSION_VALUE

        public static final java.lang.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 Detail

      • AbstractFixJavadocMojo

        public AbstractFixJavadocMojo()
    • Method Detail

      • 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
      • getArtifactType

        protected java.lang.String getArtifactType​(org.apache.maven.project.MavenProject p)
        Parameters:
        p - not null maven project.
        Returns:
        the artifact type.
      • getProjectSourceRoots

        protected java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.String getJavaMethodAsString​(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)
        Parameters:
        javaExecutable - not null
        Returns:
        the fully qualify name of javaMethod with signature