org.codehaus.gmavenplus.mojo

Class ExecuteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

org.codehaus.gmavenplus.mojo.ExecuteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class ExecuteMojo
extends AbstractGroovyMojo

Executes Groovy scripts (in the pom or external).

Author:

Keegan Witt

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	continueExecuting Whether to continue executing remaining scripts when a script fails.
protected static Version	MIN_GROOVY_VERSION The minimum version of Groovy that this mojo supports.
protected Properties	properties Properties to make available in scripts.
protected String[]	scripts Groovy scripts to run (in order).
protected String	sourceEncoding The encoding of script files.

Fields inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

GROOVY_SOURCES_PATTERN, JAVA_SOURCES_PATTERN, localRepository, pluginArtifacts, project, reactorProjects, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ExecuteMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Executes this mojo.
protected boolean	groovyVersionSupportsAction() Determines whether this mojo can be run with the version of Groovy supplied.

Methods inherited from class org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

getGroovyDependency, getGroovyVersion, getGroovyVersionString, getJavaVersion, getJavaVersionString, isGroovyArtifactId, isGroovyArtifactId, isGroovyGroupId, isGroovyGroupId, isGroovyIndy, isJavaSupportIndy, logGroovyVersion

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 Detail

MIN_GROOVY_VERSION

protected static final Version MIN_GROOVY_VERSION

The minimum version of Groovy that this mojo supports.

scripts

protected String[] scripts

Groovy scripts to run (in order). Can be an actual Groovy script or a URL to a Groovy script (local or remote).

continueExecuting

protected boolean continueExecuting

Whether to continue executing remaining scripts when a script fails.

sourceEncoding

protected String sourceEncoding

The encoding of script files.

properties

protected Properties properties

Properties to make available in scripts. By default it will include

settings

a org.apache.maven.settings.Settings object of the current Maven settings

project

a org.apache.maven.project.Project object of the current Maven project

session

a org.apache.maven.execution.MavenSession object of the current Maven session

pluginArtifacts

a list of org.apache.maven.artifact.Artifact objects of this plugin's artifacts

localRepository

a org.apache.maven.artifact.repository.ArtifactRepository object of Maven's local repository

reactorProjects

a list of org.apache.maven.project.MavenProject objects currently loaded by the reactor

These can be overridden.

Constructor Detail

ExecuteMojo

public ExecuteMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Executes this mojo.

Throws:

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

groovyVersionSupportsAction

protected boolean groovyVersionSupportsAction()

Determines whether this mojo can be run with the version of Groovy supplied. Must be >= 1.8.2 because not all the classes needed were available and functioning correctly in previous versions.

Returns:

true only if the version of Groovy supports this mojo.