carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/templatewizard/process/AbstractProcess.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_15) on Tue Jan 06 17:31:54 CST 2009 -->
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>
AbstractProcess (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.templatewizard.process.AbstractProcess class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AbstractProcess (Carbide.c++ SDK API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractProcess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProjectProcess.html" title="class in com.nokia.carbide.templatewizard.process"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/templatewizard/process/AbstractProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractProcess.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.nokia.carbide.templatewizard.process</FONT>
<BR>
Class AbstractProcess</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.nokia.carbide.templatewizard.process.AbstractProcess</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html" title="interface in com.nokia.carbide.templatewizard.process">IProcess</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProjectProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProjectProcess</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CreateTemplateVariable.html" title="class in com.nokia.carbide.templatewizard.processes">CreateTemplateVariable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractProcess</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html" title="interface in com.nokia.carbide.templatewizard.process">IProcess</A></DL>
</PRE>
<P>
An abstract base class to enable implementing
<code>com.nokia.carbide.templatewizard.process.IProcess</code>
Includes methods for initialization, failure handling and accessing parameters.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#AbstractProcess()">AbstractProcess</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#fail(java.lang.String)">fail</A></B>(java.lang.String message)</CODE>
<BR>
Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#fail(java.lang.String, java.lang.Throwable)">fail</A></B>(java.lang.String message,
java.lang.Throwable t)</CODE>
<BR>
Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#failIfFalse(boolean, java.lang.String)">failIfFalse</A></B>(boolean condition,
java.lang.String message)</CODE>
<BR>
Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#failIfNull(java.lang.Object, java.lang.String)">failIfNull</A></B>(java.lang.Object object,
java.lang.String message)</CODE>
<BR>
Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#findParameterByName(java.lang.String, java.util.List)">findParameterByName</A></B>(java.lang.String parameterName,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)</CODE>
<BR>
Encapsulates getting a singleton <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> that may or may not exist,<br>
returning <code>null</code> if none is found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected abstract Plugin</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getPlugin()">getPlugin</A></B>()</CODE>
<BR>
Must be implemented by subclasses to provide the <CODE>Plugin</CODE>
needed to construct a <CODE>CoreException</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getProcessName()">getProcessName</A></B>()</CODE>
<BR>
The class attribute of the <process> element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getRequiredAttributeFromParameter(com.nokia.carbide.templatewizard.process.IParameter, java.lang.String)">getRequiredAttributeFromParameter</A></B>(<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A> parameter,
java.lang.String attributeName)</CODE>
<BR>
Encapsulates getting a required attribute from an <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> by name,<br>
or throwing a <CODE>CoreException</CODE>, if none is found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getRequiredParameterByName(java.lang.String, java.util.List)">getRequiredParameterByName</A></B>(java.lang.String parameterName,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)</CODE>
<BR>
Encapsulates getting a singleton <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> that is required to exist,<br>
or throwing a <CODE>CoreException</CODE>, if none is found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#init(com.nokia.carbide.template.engine.ITemplate, java.util.List)">init</A></B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)</CODE>
<BR>
Must be implemented by subclasses.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#mustRunInUIThread()">mustRunInUIThread</A></B>()</CODE>
<BR>
This method is called before executing this process, to determine whether it should be executed in
the UI thread.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)">process</A></B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters,
IProgressMonitor monitor)</CODE>
<BR>
The main method called to execute this process.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#setRunInUIThread(boolean)">setRunInUIThread</A></B>(boolean runInUIThread)</CODE>
<BR>
Can be called in constructor to set the return value of <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()"><CODE>IProcess.mustRunInUIThread()</CODE></A></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AbstractProcess()"><!-- --></A><H3>
AbstractProcess</H3>
<PRE>
public <B>AbstractProcess</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getProcessName()"><!-- --></A><H3>
getProcessName</H3>
<PRE>
protected java.lang.String <B>getProcessName</B>()</PRE>
<DL>
<DD>The class attribute of the <process> element.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>java.lang.String</code></DL>
</DD>
</DL>
<HR>
<A NAME="getPlugin()"><!-- --></A><H3>
getPlugin</H3>
<PRE>
protected abstract Plugin <B>getPlugin</B>()</PRE>
<DL>
<DD>Must be implemented by subclasses to provide the <CODE>Plugin</CODE>
needed to construct a <CODE>CoreException</CODE>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>org.eclipse.core.runtime.Plugin</code></DL>
</DD>
</DL>
<HR>
<A NAME="fail(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
fail</H3>
<PRE>
protected void <B>fail</B>(java.lang.String message,
java.lang.Throwable t)
throws CoreException</PRE>
<DL>
<DD>Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the String message of the exception<DD><CODE>t</CODE> - a Throwable
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="fail(java.lang.String)"><!-- --></A><H3>
fail</H3>
<PRE>
protected void <B>fail</B>(java.lang.String message)
throws CoreException</PRE>
<DL>
<DD>Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the String message of the exception
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="failIfFalse(boolean, java.lang.String)"><!-- --></A><H3>
failIfFalse</H3>
<PRE>
protected void <B>failIfFalse</B>(boolean condition,
java.lang.String message)
throws CoreException</PRE>
<DL>
<DD>Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>condition</CODE> - throws CoreException if false<DD><CODE>message</CODE> - the String message of the exception
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="failIfNull(java.lang.Object, java.lang.String)"><!-- --></A><H3>
failIfNull</H3>
<PRE>
protected void <B>failIfNull</B>(java.lang.Object object,
java.lang.String message)
throws CoreException</PRE>
<DL>
<DD>Called by subclasses to encapsulate throwing a CoreException from
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - throws CoreException if null<DD><CODE>message</CODE> - the String message of the exception
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="init(com.nokia.carbide.template.engine.ITemplate, java.util.List)"><!-- --></A><H3>
init</H3>
<PRE>
protected abstract void <B>init</B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)
throws CoreException</PRE>
<DL>
<DD>Must be implemented by subclasses.<br>
Called by <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><CODE>IProcess.process(ITemplate, List, IProgressMonitor)</CODE></A>
to separate initialization from processing code.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - the ITemplate argument to process<DD><CODE>parameters</CODE> - the parameter list argument to process
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE><DT><B>See Also:</B><DD><CODE>com.nokia.carbide.templatewizard.process.IProcess#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, org.eclipse.core.runtime.IProgressMonitor)</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)"><!-- --></A><H3>
process</H3>
<PRE>
public void <B>process</B>(<A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine">ITemplate</A> template,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters,
IProgressMonitor monitor)
throws CoreException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)">IProcess</A></CODE></B></DD>
<DD>The main method called to execute this process.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)">process</A></CODE> in interface <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html" title="interface in com.nokia.carbide.templatewizard.process">IProcess</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - the <A HREF="../../../../../com/nokia/carbide/template/engine/ITemplate.html" title="interface in com.nokia.carbide.template.engine"><CODE>ITemplate</CODE></A> for this process<DD><CODE>parameters</CODE> - a list of <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A><DD><CODE>monitor</CODE> - the <CODE>IProgressMonitor</CODE>
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE> - if the process fails</DL>
</DD>
</DL>
<HR>
<A NAME="mustRunInUIThread()"><!-- --></A><H3>
mustRunInUIThread</H3>
<PRE>
public boolean <B>mustRunInUIThread</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()">IProcess</A></CODE></B></DD>
<DD>This method is called before executing this process, to determine whether it should be executed in
the UI thread.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()">mustRunInUIThread</A></CODE> in interface <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html" title="interface in com.nokia.carbide.templatewizard.process">IProcess</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> to ensure this process is executed in the UI thread.<DT><B>See Also:</B><DD><CODE>org.eclipse.swt.widgets.Display#syncExec(Runnable)</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setRunInUIThread(boolean)"><!-- --></A><H3>
setRunInUIThread</H3>
<PRE>
public void <B>setRunInUIThread</B>(boolean runInUIThread)</PRE>
<DL>
<DD>Can be called in constructor to set the return value of <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()"><CODE>IProcess.mustRunInUIThread()</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>runInUIThread</CODE> - the return value of <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IProcess.html#mustRunInUIThread()"><CODE>IProcess.mustRunInUIThread()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="findParameterByName(java.lang.String, java.util.List)"><!-- --></A><H3>
findParameterByName</H3>
<PRE>
protected <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A> <B>findParameterByName</B>(java.lang.String parameterName,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)
throws CoreException</PRE>
<DL>
<DD>Encapsulates getting a singleton <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> that may or may not exist,<br>
returning <code>null</code> if none is found.<br>
Returns the first <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> found by name.
Optional parameters can be accessed via the parameters list.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameterName</CODE> - the name of the parameter<DD><CODE>parameters</CODE> - the list of parameters
<DT><B>Returns:</B><DD>the first IParameter with name parameterName or <code>null</code>
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getRequiredParameterByName(java.lang.String, java.util.List)"><!-- --></A><H3>
getRequiredParameterByName</H3>
<PRE>
protected <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A> <B>getRequiredParameterByName</B>(java.lang.String parameterName,
java.util.List<<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A>> parameters)
throws CoreException</PRE>
<DL>
<DD>Encapsulates getting a singleton <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> that is required to exist,<br>
or throwing a <CODE>CoreException</CODE>, if none is found.<br>
Returns the first <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> found by name.
Optional parameters can be accessed via the parameters list.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameterName</CODE> - the name of the parameter<DD><CODE>parameters</CODE> - the list of parameters
<DT><B>Returns:</B><DD>the first IParameter with name parameterName
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE> - if parameter is not found</DL>
</DD>
</DL>
<HR>
<A NAME="getRequiredAttributeFromParameter(com.nokia.carbide.templatewizard.process.IParameter, java.lang.String)"><!-- --></A><H3>
getRequiredAttributeFromParameter</H3>
<PRE>
protected java.lang.String <B>getRequiredAttributeFromParameter</B>(<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A> parameter,
java.lang.String attributeName)
throws CoreException</PRE>
<DL>
<DD>Encapsulates getting a required attribute from an <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process"><CODE>IParameter</CODE></A> by name,<br>
or throwing a <CODE>CoreException</CODE>, if none is found.<br>
Optional attributes can be accessed via <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html#getAttributeValue(java.lang.String)"><CODE>IParameter.getAttributeValue(String)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameter</CODE> - the IParameter<DD><CODE>attributeName</CODE> - the attribute name
<DT><B>Returns:</B><DD>the String attribute from parameter with attributeName
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE> - if attribute is not found</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractProcess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Carbide.c++</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProjectProcess.html" title="class in com.nokia.carbide.templatewizard.process"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/nokia/carbide/templatewizard/process/AbstractProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractProcess.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<div id="footer">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</BODY>
</HTML>