Class ParanamerGeneratorMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
com.thoughtworks.paranamer.mojo.ParanamerGeneratorMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate", defaultPhase=COMPILE, requiresDependencyResolution=COMPILE) public class ParanamerGeneratorMojo extends org.apache.maven.plugin.AbstractMojo
Mojo to generate parameter names via ParanamerGenerator
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    The Paranamer generator
    protected String
    The directory where the Paranamer generator will write the output
    static final String
    THe system property name, which if set, will skip execution of this mojo
    protected String
    The directory containing the Java source files

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

    ROLE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    boolean
    Determines if the skip property is set

    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 Details

    • skipProp

      public static final String skipProp
      THe system property name, which if set, will skip execution of this mojo
      See Also:
    • sourceDirectory

      @Parameter(defaultValue="${project.build.sourceDirectory}", required=true) protected String sourceDirectory
      The directory containing the Java source files
    • outputDirectory

      @Parameter(defaultValue="${project.build.outputDirectory}", required=true) protected String outputDirectory
      The directory where the Paranamer generator will write the output
    • generator

      private ParanamerGenerator generator
      The Paranamer generator
  • Constructor Details

    • ParanamerGeneratorMojo

      public ParanamerGeneratorMojo()
  • Method Details

    • skip

      public boolean skip()
      Determines if the skip property is set
      Returns:
      true if the skip property is set, false otherwise
    • 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