Package org.codehaus.mojo.exec
Class AbstractExecMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.codehaus.mojo.exec.AbstractExecMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
ExecJavaMojo
,ExecMojo
public abstract class AbstractExecMojo extends org.apache.maven.plugin.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
Fields Modifier and Type Field Description protected java.lang.String
classpathScope
Defines the scope of the classpath passed to the plugin.protected ExecutableDependency
executableDependency
If provided the ExecutableDependency identifies which of the plugin dependencies contains the executable class.protected org.apache.maven.project.MavenProject
project
The enclosing project.
-
Constructor Summary
Constructors Constructor Description AbstractExecMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
collectProjectArtifactsAndClasspath(java.util.List<org.apache.maven.artifact.Artifact> artifacts, java.util.List<java.nio.file.Path> 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 org.apache.maven.artifact.Artifact
findExecutableArtifact()
Examine the plugin dependencies to find the executable artifact.protected org.apache.maven.execution.MavenSession
getSession()
protected boolean
hasCommandlineArgs()
protected boolean
isSkip()
Check if the execution should be skippedprotected java.lang.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
-
-
-
-
Field Detail
-
project
@Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject project
The enclosing project.
-
executableDependency
@Parameter protected ExecutableDependency executableDependency
If provided the ExecutableDependency identifies which of the plugin dependencies contains the executable class. This will have the effect of only including plugin dependencies required by the identified ExecutableDependency.If includeProjectDependencies is set to
true
, all of the project dependencies will be included on the executable's classpath. Whether a particular project dependency is a dependency of the identified ExecutableDependency will be irrelevant to its inclusion in the classpath.- Since:
- 1.1-beta-1
-
classpathScope
@Parameter(property="exec.classpathScope", defaultValue="runtime") protected java.lang.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'.
-
-
Method Detail
-
collectProjectArtifactsAndClasspath
protected void collectProjectArtifactsAndClasspath(java.util.List<org.apache.maven.artifact.Artifact> artifacts, java.util.List<java.nio.file.Path> 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 artifactstheClasspathFiles
- the list where to collect the scope specific output directories
-
parseCommandlineArgs
protected java.lang.String[] parseCommandlineArgs() throws org.apache.maven.plugin.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:
org.apache.maven.plugin.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
-
getSession
protected final org.apache.maven.execution.MavenSession getSession()
-
findExecutableArtifact
protected org.apache.maven.artifact.Artifact findExecutableArtifact() throws org.apache.maven.plugin.MojoExecutionException
Examine the plugin dependencies to find the executable artifact.- Returns:
- an artifact which refers to the actual executable tool (not a POM)
- Throws:
org.apache.maven.plugin.MojoExecutionException
- if no executable artifact was found
-
-