Class HelpGeneratorMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.plugin.AbstractGeneratorMojo
org.apache.maven.plugin.plugin.HelpGeneratorMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="helpmojo", defaultPhase=GENERATE_SOURCES, threadSafe=true, requiresDependencyResolution=COMPILE) public class HelpGeneratorMojo extends AbstractGeneratorMojo
Generates a HelpMojo class. Relies at runtime on one output file from DescriptorGeneratorMojo.
Since:
2.4
  • Field Details

    • outputDirectory

      @Parameter(defaultValue="${project.build.directory}/generated-sources/plugin") protected File outputDirectory
      The directory where the generated HelpMojo file will be put.
    • helpPackageName

      @Parameter private String helpPackageName
      The name of the package for the generated HelpMojo.

      By default, the package name will be calculated as groupId + "." + artifactId with additional

      • - (dashes) will be replaced by _ (underscores)
      • _ (underscore) will be added before each number or Java keyword at the beginning of name
      Since:
      2.6
    • velocity

      @Component private org.codehaus.plexus.velocity.VelocityComponent velocity
      Velocity component.
  • Constructor Details

    • HelpGeneratorMojo

      public HelpGeneratorMojo()
  • Method Details

    • getHelpPackageName

      String getHelpPackageName()
    • prefixSpecialCase

      private String prefixSpecialCase(String name)
    • generate

      protected void generate() throws org.apache.maven.plugin.MojoExecutionException
      Specified by:
      generate in class AbstractGeneratorMojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException