Package org.apache.maven.plugin.plugin

Class AbstractGeneratorMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    Direct Known Subclasses:
    DescriptorGeneratorMojo, HelpGeneratorMojo
    public abstract class AbstractGeneratorMojo
extends org.apache.maven.plugin.AbstractMojo
    Abstract class for this Plugin.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String goalPrefix
      The goal prefix that will appear before the ":".
      protected static java.lang.String LS
      System/OS line separator: used to format console messages.
      private java.util.List<java.lang.String> packagingTypes
      Maven plugin packaging types.
      protected org.apache.maven.project.MavenProject project
      The project currently being built.
      private boolean skip
      Set this to "true" to skip invoking any goals or reports of the plugin.

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

        ROLE

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()  
      protected abstract void generate()  
      (package private) static java.lang.String getDefaultGoalPrefix​(org.apache.maven.project.MavenProject project)  

      • 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

      • project

        @Component
protected org.apache.maven.project.MavenProject project
        The project currently being built.

      • goalPrefix

        @Parameter
protected java.lang.String goalPrefix
        The goal prefix that will appear before the ":".

      • skip

        @Parameter(defaultValue="false",
           property="maven.plugin.skip")
private boolean skip
        Set this to "true" to skip invoking any goals or reports of the plugin.
        Since:
        2.8

      • packagingTypes

        @Parameter
private java.util.List<java.lang.String> packagingTypes
        Maven plugin packaging types. Default is single "maven-plugin".
        Since:
        3.3

      • LS

        protected static final java.lang.String LS
        System/OS line separator: used to format console messages.

    • Constructor Detail

      • AbstractGeneratorMojo

        public AbstractGeneratorMojo()

    • Method Detail

      • generate

        protected abstract void generate()
                          throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • execute

        public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • getDefaultGoalPrefix

        static java.lang.String getDefaultGoalPrefix​(org.apache.maven.project.MavenProject project)