Class AbstractGeneratorMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.plugin.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 String
    goalPrefix
    The goal prefix that will appear before the ":".
    protected static final String
    LS
    System/OS line separator: used to format console messages.
    private List<String>
    packagingTypes
    Maven plugin packaging types.
    protected final 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

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractGeneratorMojo(org.apache.maven.project.MavenProject project)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
     
    protected abstract void
    generate()
     
    (package private) static 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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • goalPrefix

      @Parameter protected 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 List<String> packagingTypes
      Maven plugin packaging types. Default is single "maven-plugin".
      Since:
      3.3

    • LS

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

    • project

      protected final org.apache.maven.project.MavenProject project
      The project currently being built.

  • Constructor Details

    • AbstractGeneratorMojo

      protected AbstractGeneratorMojo(org.apache.maven.project.MavenProject project)

  • Method Details

    • 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 String getDefaultGoalPrefix(org.apache.maven.project.MavenProject project)