Package org.eclipse.cdt.core.templateengine.process

Class ProcessRunner

java.lang.Object

org.eclipse.cdt.core.templateengine.process.ProcessRunner

Direct Known Subclasses:

AddFile, AddFiles, AddLink, AddNature, Append, AppendCreate, Copy, CreateFolder, CreateResourceIdentifier, CreateSourceFolder, SetEnvironmentVariable

public abstract class ProcessRunner
extends java.lang.Object

Abstract ProcessRunner class provides the methods to implement for processes.

Constructor Summary

Constructors

Constructor	Description
ProcessRunner()

Method Summary

Modifier and Type	Method	Description
protected boolean	areArgumentsMatchingRequiredParameters(ProcessArgument[] args)	Checks the whether the arguments are matching the required parameters.
java.lang.String	getArgumentsMismatchMessage(ProcessArgument[] args)	Return the String containing the mismatching message if the arguments are not matching the required parameters.
protected java.lang.String	getProcessMessage(java.lang.String processId, int code, java.lang.String msg)	Returns the process message based on the parameters.
ProcessParameter[]	getProcessParameters()	Returns the Process Parameters.
protected ProcessFailureException	missingArgException(java.lang.String processId, java.lang.String varname)
abstract void	process(TemplateCore template, ProcessArgument[] args, java.lang.String processId, org.eclipse.core.runtime.IProgressMonitor monitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessRunner

public ProcessRunner()

Method Detail

getProcessParameters

public ProcessParameter[] getProcessParameters()

Returns the Process Parameters.

missingArgException

protected ProcessFailureException missingArgException(java.lang.String processId,
                                                      java.lang.String varname)

Since:

5.6

areArgumentsMatchingRequiredParameters

protected final boolean areArgumentsMatchingRequiredParameters(ProcessArgument[] args)

Checks the whether the arguments are matching the required parameters.

getArgumentsMismatchMessage

public java.lang.String getArgumentsMismatchMessage(ProcessArgument[] args)

Return the String containing the mismatching message if the arguments are not matching the required parameters.

getProcessMessage

protected final java.lang.String getProcessMessage(java.lang.String processId,
                                                   int code,
                                                   java.lang.String msg)

Returns the process message based on the parameters.

process

public abstract void process(TemplateCore template,
                             ProcessArgument[] args,
                             java.lang.String processId,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws ProcessFailureException

Parameters:

template -

args -

processId -

Throws:

ProcessFailureException