Class ClassListerMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    public class ClassListerMojo
    extends AbstractAdamsMojo
    Outputs the classes or packages as props files.
    FracPete (fracpete at waikato dot ac dot nz)
    • Constructor Detail

      • ClassListerMojo

        public ClassListerMojo()
    • Method Detail

      • shouldExecutionBeSkipped

        protected boolean shouldExecutionBeSkipped()
        Implement this method to check if this AbstractAdamsMojo should skip executing altogether.
        Specified by:
        shouldExecutionBeSkipped in class AbstractAdamsMojo
        true to indicate that this AbstractAdamsMojo should bail out of its execute method.
      • addResource

        protected void addResource​(org.apache.maven.model.Resource resource)
        Adds the supplied Resource to the project using the appropriate scope (i.e. resource or testResource) depending on the exact implementation of this AbstractAdamsMojo.
        Specified by:
        addResource in class AbstractAdamsMojo
        resource - The resource to add.
      • isReGenerationRequired

        protected boolean isReGenerationRequired()

        Java generation is required if any of the file products is outdated/stale.

        Specified by:
        isReGenerationRequired in class AbstractAdamsMojo
        true to indicate that this AbstractAdamsMojo should be run since its generated files were either stale or not present, and false otherwise.
      • execute

        protected void execute​(List<String> cmd)
                        throws org.apache.maven.plugin.MojoExecutionException
        Executes the command.
        cmd - the command to execute
        org.apache.maven.plugin.MojoExecutionException - if command exits with code != 0 or an exception occurred
      • performExecution

        protected boolean performExecution()
                                    throws org.apache.maven.plugin.MojoExecutionException,

        Implement this method to perform this Mojo's execution. This method will only be called if !shouldExecutionBeSkipped() && isReGenerationRequired().

        Specified by:
        performExecution in class AbstractAdamsMojo
        true if the timestamp of the stale file should be updated.
        org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.
        org.apache.maven.plugin.MojoFailureException - if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.
      • getOutputDirectory

        protected File getOutputDirectory()
        Retrieves the directory where the generated files should be written to.
        Specified by:
        getOutputDirectory in class AbstractAdamsMojo
        the directory where the generated files should be written to.