Carbide.c++

com.nokia.carbide.templatewizard.processes
Class CreateTemplateVariable

java.lang.Object
  extended by com.nokia.carbide.templatewizard.process.AbstractProcess
      extended by com.nokia.carbide.templatewizard.processes.CreateTemplateVariable
All Implemented Interfaces:
IProcess

public class CreateTemplateVariable
extends AbstractProcess

Process used in templates to create variables used for text substitution in other template files.

Since:
1.4

Field Summary
protected static java.lang.String NAME_ATTRIBUTE
           
protected static java.lang.String VALUE_ATTRIBUTE
           
protected static java.lang.String VARIABLE_PARAMETER
           
 
Constructor Summary
CreateTemplateVariable()
           
 
Method Summary
protected  Plugin getPlugin()
          Must be implemented by subclasses to provide the Plugin needed to construct a CoreException.
protected  void init(ITemplate template, java.util.List<IParameter> parameters)
          Must be implemented by subclasses.
 void process(ITemplate template, java.util.List<IParameter> parameters, IProgressMonitor monitor)
          The main method called to execute this process.
 
Methods inherited from class com.nokia.carbide.templatewizard.process.AbstractProcess
fail, fail, failIfFalse, failIfNull, findParameterByName, getProcessName, getRequiredAttributeFromParameter, getRequiredParameterByName, mustRunInUIThread, setRunInUIThread
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VARIABLE_PARAMETER

protected static final java.lang.String VARIABLE_PARAMETER
See Also:
Constant Field Values

NAME_ATTRIBUTE

protected static final java.lang.String NAME_ATTRIBUTE
See Also:
Constant Field Values

VALUE_ATTRIBUTE

protected static final java.lang.String VALUE_ATTRIBUTE
See Also:
Constant Field Values
Constructor Detail

CreateTemplateVariable

public CreateTemplateVariable()
Method Detail

process

public void process(ITemplate template,
                    java.util.List<IParameter> parameters,
                    IProgressMonitor monitor)
             throws CoreException
Description copied from interface: IProcess
The main method called to execute this process.

Specified by:
process in interface IProcess
Overrides:
process in class AbstractProcess
Parameters:
template - the ITemplate for this process
parameters - a list of IParameter
monitor - the IProgressMonitor
Throws:
CoreException - if the process fails

init

protected void init(ITemplate template,
                    java.util.List<IParameter> parameters)
             throws CoreException
Description copied from class: AbstractProcess
Must be implemented by subclasses.
Called by IProcess.process(ITemplate, List, IProgressMonitor) to separate initialization from processing code.

Specified by:
init in class AbstractProcess
Parameters:
template - the ITemplate argument to process
parameters - the parameter list argument to process
Throws:
CoreException
See Also:
com.nokia.carbide.templatewizard.process.IProcess#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, org.eclipse.core.runtime.IProgressMonitor)

getPlugin

protected Plugin getPlugin()
Description copied from class: AbstractProcess
Must be implemented by subclasses to provide the Plugin needed to construct a CoreException.

Specified by:
getPlugin in class AbstractProcess
Returns:
org.eclipse.core.runtime.Plugin

Carbide.c++