Package org.codehaus.gmavenplus.mojo

Class ConsoleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.gmavenplus.mojo.AbstractGroovyMojo

org.codehaus.gmavenplus.mojo.AbstractToolsMojo

org.codehaus.gmavenplus.mojo.ConsoleMojo

All Implemented Interfaces:

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

@Mojo(name="console",
      requiresDependencyResolution=TEST,
      configurator="include-project-test-dependencies")
public class ConsoleMojo
extends AbstractToolsMojo

Launches a Groovy console window bound to the current project. Note that this mojo requires Groovy >= 1.5.0. Note that it references the plugin classloader to pull in dependencies Groovy didn't include (for things like Ant for AntBuilder, Ivy for @grab, and Jansi for Groovysh).

Since:

1.1

Author:

Keegan Witt

Field Summary

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

allowSystemExits, bindPropertiesToSeparateVariables, projectHelper, properties

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

classWrangler, GROOVY_1_5_0, GROOVY_SOURCES_PATTERN, JAVA_1_7, JAVA_1_8, JAVA_SOURCES_PATTERN, minGroovyVersion, mojoExecution, pluginArtifacts, project, session, skipTests

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ConsoleMojo()

Method Summary

Modifier and Type	Method	Description
protected void	bindAntBuilder(Class<?> consoleClass, Class<?> bindingClass, Object console)	Binds a new AntBuilder to the project properties.
void	execute()	Executes this mojo.
protected Object	setupConsole(Class<?> consoleClass, Class<?> bindingClass)	Instantiates a Groovy Console.

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

initializeProperties, logUnableToInitializeAntBuilder

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

getJavaVersion, getJavaVersionString, groovyAtLeast, groovyIs, groovyNewerThan, groovyOlderThan, groovyVersionSupportsAction, isJavaSupportIndy, isJavaSupportParameters, logPluginClasspath

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

Constructor Detail

ConsoleMojo

public ConsoleMojo()

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 an invocation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed

bindAntBuilder

protected void bindAntBuilder(Class<?> consoleClass,
                              Class<?> bindingClass,
                              Object console)
                       throws ClassNotFoundException,
                              IllegalAccessException,
                              InvocationTargetException,
                              InstantiationException

Binds a new AntBuilder to the project properties.

Parameters:

consoleClass - the groovy.ui.Console class to use

bindingClass - the groovy.lang.Binding class to use

console - the groovy.ui.Console object to use

Throws:

ClassNotFoundException

IllegalAccessException

InvocationTargetException

InstantiationException

setupConsole

protected Object setupConsole(Class<?> consoleClass,
                              Class<?> bindingClass)
                       throws InvocationTargetException,
                              IllegalAccessException,
                              InstantiationException

Instantiates a Groovy Console.

Parameters:

consoleClass - the Console class

bindingClass - the Binding class

Returns:

the instantiated Console

Throws:

InstantiationException - when a class needed for creating a console cannot be instantiated

IllegalAccessException - when a method needed for creating a console cannot be accessed

InvocationTargetException - when a reflection invocation needed for creating a console cannot be completed