org.apache.maven.plugin.cxx

Class AbstractLaunchMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.cxx.AbstractCxxMojo

org.apache.maven.plugin.cxx.AbstractLaunchMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CMakeMojo, CppCheckMojo, CppNcssMojo, LaunchMojo, MakeMojo, QMakeMojo, ValgrindMojo, VeraxxMojo, VisualStudioMojo

public abstract class AbstractLaunchMojo
extends AbstractCxxMojo

Common mojo stuff to launch external tools

Author:

Franck Bonin

Field Summary

Fields inherited from class org.apache.maven.plugin.cxx.AbstractCxxMojo

basedir, project, reactorProjects, session, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLaunchMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected abstract List<String>	getArgsList()
protected abstract String	getCommandArgs()
protected Properties	getEnvs()
protected abstract String	getExecutable()
protected InputStream	getInputStream()
protected abstract Map	getMoreEnvironmentVariables()
protected OutputStream	getOutputStreamErr()
protected OutputStream	getOutputStreamOut()
protected abstract List<String>	getSuccesCode() The current build session instance.
protected abstract File	getWorkingDir()
protected boolean	isResultCodeAFailure(int result)
protected abstract boolean	isSkip()
protected String[]	parseCommandlineArgs(String commandLineArgs)
protected void	postExecute(int resultCode)
protected void	preExecute(org.apache.commons.exec.Executor exec, org.apache.commons.exec.CommandLine commandLine, Properties enviro)

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

AbstractLaunchMojo

public AbstractLaunchMojo()

Method Detail

getArgsList

protected abstract List<String> getArgsList()

getCommandArgs

protected abstract String getCommandArgs()

parseCommandlineArgs

protected String[] parseCommandlineArgs(String commandLineArgs)
                                 throws org.apache.maven.plugin.MojoExecutionException

Returns:

Array of String representing the arguments

Throws:

org.apache.maven.plugin.MojoExecutionException - for wrong formatted arguments

getExecutable

protected abstract String getExecutable()

getMoreEnvironmentVariables

protected abstract Map getMoreEnvironmentVariables()

getEnvs

protected Properties getEnvs()

getWorkingDir

protected abstract File getWorkingDir()

getSuccesCode

protected abstract List<String> getSuccesCode()

The current build session instance.

isResultCodeAFailure

protected boolean isResultCodeAFailure(int result)

isSkip

protected abstract boolean isSkip()

getOutputStreamOut

protected OutputStream getOutputStreamOut()

getOutputStreamErr

protected OutputStream getOutputStreamErr()

getInputStream

protected InputStream getInputStream()

preExecute

protected void preExecute(org.apache.commons.exec.Executor exec,
                          org.apache.commons.exec.CommandLine commandLine,
                          Properties enviro)
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

postExecute

protected void postExecute(int resultCode)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException