org.codehaus.mojo.exec
Class AbstractExecMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.exec.AbstractExecMojo
All Implemented Interfaces:
ContextEnabled, Mojo
Direct Known Subclasses:
ExecJavaMojo, ExecMojo

public abstract class AbstractExecMojo
extends AbstractMojo

This class is used for unifying functionality between the 2 mojo exec plugins ('java' and 'exec'). It handles parsing the arguments and adding source/test folders.

Author:
Philippe Jacot (PJA), Jerome Lacoste

Field Summary
protected  String classpathScope
          Defines the scope of the classpath passed to the plugin.
protected  MavenProject project
          The enclosing project.
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractExecMojo()
           
 
Method Summary
protected  void collectProjectArtifactsAndClasspath(List artifacts, List theClasspathFiles)
          Collects the project artifacts in the specified List and the project specific classpath (build output and build test output) Files in the specified List, depending on the plugin classpathScope value.
protected  boolean hasCommandlineArgs()
           
protected  boolean isSkip()
          Check if the execution should be skipped
protected  String[] parseCommandlineArgs()
          Parses the argument string given by the user.
protected  void registerSourceRoots()
          Register compile and compile tests source roots if necessary
 
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
 
Methods inherited from interface org.apache.maven.plugin.Mojo
execute
 

Field Detail

project

protected MavenProject project
The enclosing project.

Is defined by:
default-value:
${project}
Is required.
Is readonly.

classpathScope

protected String classpathScope
Defines the scope of the classpath passed to the plugin. Set to compile,test,runtime or system depending on your needs. Since 1.1.2, the default value is 'runtime' instead of 'compile'.

Is defined by:
expression:
${exec.classpathScope}
default-value:
runtime
Constructor Detail

AbstractExecMojo

public AbstractExecMojo()
Method Detail

collectProjectArtifactsAndClasspath

protected void collectProjectArtifactsAndClasspath(List artifacts,
                                                   List theClasspathFiles)
Collects the project artifacts in the specified List and the project specific classpath (build output and build test output) Files in the specified List, depending on the plugin classpathScope value.

Parameters:
artifacts - the list where to collect the scope specific artifacts
theClasspathFiles - the list where to collect the scope specific output directories

parseCommandlineArgs

protected String[] parseCommandlineArgs()
                                 throws MojoExecutionException
Parses the argument string given by the user. Strings are recognized as everything between STRING_WRAPPER. PARAMETER_DELIMITER is ignored inside a string. STRING_WRAPPER and PARAMETER_DELIMITER can be escaped using ESCAPE_CHAR.

Returns:
Array of String representing the arguments
Throws:
MojoExecutionException - for wrong formatted arguments

hasCommandlineArgs

protected boolean hasCommandlineArgs()
Returns:
true of the mojo has command line arguments

registerSourceRoots

protected void registerSourceRoots()
Register compile and compile tests source roots if necessary


isSkip

protected boolean isSkip()
Check if the execution should be skipped

Returns:
true to skip


Copyright © 2005-2012 Codehaus. All Rights Reserved.