Package adams.flow.maven

Class ApplyActorMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="apply",
      threadSafe=true,
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE)
public class ApplyActorMojo
extends AbstractJavaGeneratorMojo
    Calls the ApplyActorProducer.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)

    • Constructor Detail

      • ApplyActorMojo

        public ApplyActorMojo()

    • Method Detail

      • shouldExecutionBeSkipped

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

      • classOutputDir

        protected File classOutputDir()
        Returns the directory for the class file (including the package).
        Returns:
        the directory

      • classOutputFile

        protected File classOutputFile()
        Returns the full filename for the Java class to generate.
        Returns:
        the filename

      • generateCode

        protected boolean generateCode()
                        throws org.apache.maven.plugin.MojoExecutionException
        Generates the actual code.
        Specified by:
        generateCode in class AbstractJavaGeneratorMojo
        Returns:
        true if successfully generated
        Throws:
        org.apache.maven.plugin.MojoExecutionException - if code generation fails

      • 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
        Parameters:
        resource - The resource to add.

      • getSources

        protected List<URL> getSources()
        Override this method to acquire a List holding all URLs to the sources for which this AbstractJavaGeneratorMojo should generate Java files. Sources are assumed to be in the form given by the sourceType value.
        Specified by:
        getSources in class AbstractJavaGeneratorMojo
        Returns:
        A non-null List holding URLs to sources for the code generation.

      • addGeneratedSourcesToProjectSourceRoot

        protected void addGeneratedSourcesToProjectSourceRoot()
        Adds any directories containing the generated classes to the appropriate Project compilation sources; either TestCompileSourceRoot or CompileSourceRoot depending on the exact Mojo implementation of this AbstractJavaGeneratorMojo.
        Specified by:
        addGeneratedSourcesToProjectSourceRoot in class AbstractJavaGeneratorMojo

      • getOutputDirectory

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