carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/reference/api/com/nokia/carbide/templatewizard/process/AbstractProjectProcess.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>
AbstractProjectProcess (Carbide.c++ SDK API Reference)
</TITLE>
<META NAME="keywords" CONTENT="com.nokia.carbide.templatewizard.process.AbstractProjectProcess class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AbstractProjectProcess (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/AbstractProjectProcess.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">
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface 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/AbstractProjectProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractProjectProcess.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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 AbstractProjectProcess</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process">com.nokia.carbide.templatewizard.process.AbstractProcess</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.nokia.carbide.templatewizard.process.AbstractProjectProcess</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/processes/CopyFiles.html" title="class in com.nokia.carbide.templatewizard.processes">CopyFiles</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/CreateFolders.html" title="class in com.nokia.carbide.templatewizard.processes">CreateFolders</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/CreateRezId.html" title="class in com.nokia.carbide.cpp.project.core.processes">CreateRezId</A>, <A HREF="../../../../../com/nokia/carbide/cpp/project/core/processes/NewProject.html" title="class in com.nokia.carbide.cpp.project.core.processes">NewProject</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/processes/OpenFileInEditor.html" title="class in com.nokia.carbide.templatewizard.processes">OpenFileInEditor</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractProjectProcess</B><DT>extends <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProcess</A></DL>
</PRE>
<P>
An abstract base class to enable implementing
<code>com.nokia.carbide.templatewizard.process.IProcess</code> <p>
Requires a parameter with name "project" and attribute "projectName".
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process"><CODE>AbstractProcess</CODE></A></DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</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/AbstractProjectProcess.html#projectParameter">projectParameter</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== 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/AbstractProjectProcess.html#AbstractProjectProcess()">AbstractProjectProcess</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 java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProjectProcess.html#getProjectName()">getProjectName</A></B>()</CODE>
<BR>
</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/AbstractProjectProcess.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>
</TABLE>
<A NAME="methods_inherited_from_class_com.nokia.carbide.templatewizard.process.AbstractProcess"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.nokia.carbide.templatewizard.process.<A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProcess</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#fail(java.lang.String)">fail</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#fail(java.lang.String, java.lang.Throwable)">fail</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#failIfFalse(boolean, java.lang.String)">failIfFalse</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#failIfNull(java.lang.Object, java.lang.String)">failIfNull</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#findParameterByName(java.lang.String, java.util.List)">findParameterByName</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getPlugin()">getPlugin</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getProcessName()">getProcessName</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getRequiredAttributeFromParameter(com.nokia.carbide.templatewizard.process.IParameter, java.lang.String)">getRequiredAttributeFromParameter</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#getRequiredParameterByName(java.lang.String, java.util.List)">getRequiredParameterByName</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#mustRunInUIThread()">mustRunInUIThread</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#process(com.nokia.carbide.template.engine.ITemplate, java.util.List, IProgressMonitor)">process</A>, <A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#setRunInUIThread(boolean)">setRunInUIThread</A></CODE></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>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="projectParameter"><!-- --></A><H3>
projectParameter</H3>
<PRE>
protected <A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface in com.nokia.carbide.templatewizard.process">IParameter</A> <B>projectParameter</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= 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="AbstractProjectProcess()"><!-- --></A><H3>
AbstractProjectProcess</H3>
<PRE>
public <B>AbstractProjectProcess</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="init(com.nokia.carbide.template.engine.ITemplate, java.util.List)"><!-- --></A><H3>
init</H3>
<PRE>
protected 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><B>Description copied from class: <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#init(com.nokia.carbide.template.engine.ITemplate, java.util.List)">AbstractProcess</A></CODE></B></DD>
<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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html#init(com.nokia.carbide.template.engine.ITemplate, java.util.List)">init</A></CODE> in class <CODE><A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process">AbstractProcess</A></CODE></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="getProjectName()"><!-- --></A><H3>
getProjectName</H3>
<PRE>
protected java.lang.String <B>getProjectName</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the value of the "projectName" attribute of the project parameter.</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/AbstractProjectProcess.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">
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/AbstractProcess.html" title="class in com.nokia.carbide.templatewizard.process"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/nokia/carbide/templatewizard/process/IParameter.html" title="interface 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/AbstractProjectProcess.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractProjectProcess.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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>