| <!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.6.0) on Wed May 14 15:16:11 EDT 2008 --> |
| <TITLE> |
| IRuntimeWorkingCopy |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-05-14"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IRuntimeWorkingCopy"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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/IRuntimeWorkingCopy.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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/server/core/IRuntimeWorkingCopy.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IRuntimeWorkingCopy.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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"> |
| org.eclipse.wst.server.core</FONT> |
| <BR> |
| Interface IRuntimeWorkingCopy</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IRuntimeWorkingCopy</B><DT>extends <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></DL> |
| </PRE> |
| |
| <P> |
| A working copy runtime object used for formulating changes |
| to a runtime instance (<A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core"><CODE>IRuntime</CODE></A>). Changes made on a |
| working copy do not occur (and are not persisted) until a |
| save() is performed. |
| <p> |
| If the client of this working copy calls loadAdapter(), a new instance of |
| the delegate (RuntimeDelegate) will be created to help this working copy. |
| This delegate instance will be used as long as this working copy exists. |
| </p> |
| <p> |
| This interface is not intended to be implemented by clients. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core"><CODE>IRuntime</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>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#PROPERTY_LOCATION">PROPERTY_LOCATION</A></B></CODE> |
| |
| <BR> |
| Property change name (value "location") used when the location of the |
| runtime changes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#PROPERTY_NAME">PROPERTY_NAME</A></B></CODE> |
| |
| <BR> |
| Property change name (value "name") used when the name of the runtime |
| changes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#SAVE_CONFLICT">SAVE_CONFLICT</A></B></CODE> |
| |
| <BR> |
| Status code (value 1) returned from the save() method when the save |
| failed with force set to <code>false</code> because the runtime has |
| been modified and saved since this working copy was created.</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</A></B>(java.beans.PropertyChangeListener listener)</CODE> |
| |
| <BR> |
| Adds a property change listener to this runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#getOriginal()">getOriginal</A></B>()</CODE> |
| |
| <BR> |
| Returns the runtime instance that this working copy is |
| associated with.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#isDirty()">isDirty</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this working copy has unsaved changes.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</A></B>(java.beans.PropertyChangeListener listener)</CODE> |
| |
| <BR> |
| Removes a property change listener from this runtime.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#save(boolean, IProgressMonitor)">save</A></B>(boolean force, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Commits the changes made in this working copy.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#setLocation(IPath)">setLocation</A></B>(IPath path)</CODE> |
| |
| <BR> |
| Sets the absolute path in the local file system to the root of the runtime, |
| typically the installation directory.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Sets the displayable name for this runtime.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#setReadOnly(boolean)">setReadOnly</A></B>(boolean readOnly)</CODE> |
| |
| <BR> |
| Sets or unsets whether this runtime is marked as read only.</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="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#setStub(boolean)">setStub</A></B>(boolean stub)</CODE> |
| |
| <BR> |
| Returns whether this runtime is a stub (used for compilation only) |
| or a full runtime.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.server.core.IRuntime"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.server.core.<A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#createWorkingCopy()">createWorkingCopy</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#delete()">delete</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getAdapter(java.lang.Class)">getAdapter</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getId()">getId</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getName()">getName</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getRuntimeType()">getRuntimeType</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#isReadOnly()">isReadOnly</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#isStub()">isStub</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#isWorkingCopy()">isWorkingCopy</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#loadAdapter(java.lang.Class, IProgressMonitor)">loadAdapter</A>, <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#validate(IProgressMonitor)">validate</A></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="SAVE_CONFLICT"><!-- --></A><H3> |
| SAVE_CONFLICT</H3> |
| <PRE> |
| static final int <B>SAVE_CONFLICT</B></PRE> |
| <DL> |
| <DD>Status code (value 1) returned from the save() method when the save |
| failed with force set to <code>false</code> because the runtime has |
| been modified and saved since this working copy was created. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#save(boolean, IProgressMonitor)"><CODE>save(boolean, IProgressMonitor)</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IRuntimeWorkingCopy.SAVE_CONFLICT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PROPERTY_NAME"><!-- --></A><H3> |
| PROPERTY_NAME</H3> |
| <PRE> |
| static final java.lang.String <B>PROPERTY_NAME</B></PRE> |
| <DL> |
| <DD>Property change name (value "name") used when the name of the runtime |
| changes. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#addPropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>addPropertyChangeListener(PropertyChangeListener)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#removePropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>removePropertyChangeListener(PropertyChangeListener)</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IRuntimeWorkingCopy.PROPERTY_NAME">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PROPERTY_LOCATION"><!-- --></A><H3> |
| PROPERTY_LOCATION</H3> |
| <PRE> |
| static final java.lang.String <B>PROPERTY_LOCATION</B></PRE> |
| <DL> |
| <DD>Property change name (value "location") used when the location of the |
| runtime changes. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#addPropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>addPropertyChangeListener(PropertyChangeListener)</CODE></A>, |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#removePropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>removePropertyChangeListener(PropertyChangeListener)</CODE></A>, |
| <A HREF="../../../../../constant-values.html#org.eclipse.wst.server.core.IRuntimeWorkingCopy.PROPERTY_LOCATION">Constant Field Values</A></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="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| void <B>setName</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Sets the displayable name for this runtime. |
| <p> |
| The name should be appropriate for the current locale. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - a displayable name<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getName()"><CODE>IRuntime.getName()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReadOnly(boolean)"><!-- --></A><H3> |
| setReadOnly</H3> |
| <PRE> |
| void <B>setReadOnly</B>(boolean readOnly)</PRE> |
| <DL> |
| <DD>Sets or unsets whether this runtime is marked as read only. |
| When a runtime is read only, working copies can be created but |
| they cannot be saved. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>readOnly</CODE> - <code>true</code> to set this runtime to be marked |
| read only, and <code>false</code> to unset</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDirty()"><!-- --></A><H3> |
| isDirty</H3> |
| <PRE> |
| boolean <B>isDirty</B>()</PRE> |
| <DL> |
| <DD>Returns whether this working copy has unsaved changes. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this working copy has unsaved |
| changes, and <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3> |
| addPropertyChangeListener</H3> |
| <PRE> |
| void <B>addPropertyChangeListener</B>(java.beans.PropertyChangeListener listener)</PRE> |
| <DL> |
| <DD>Adds a property change listener to this runtime. |
| <p> |
| Once registered, a listener starts receiving notification of |
| property changes to this runtime. The listener continues to receive |
| notifications until it is removed. |
| Has no effect if an identical listener is already registered. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a property change listener<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#removePropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>removePropertyChangeListener(PropertyChangeListener)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removePropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3> |
| removePropertyChangeListener</H3> |
| <PRE> |
| void <B>removePropertyChangeListener</B>(java.beans.PropertyChangeListener listener)</PRE> |
| <DL> |
| <DD>Removes a property change listener from this runtime. |
| Has no effect if the listener is not registered. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a property change listener<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#addPropertyChangeListener(java.beans.PropertyChangeListener)"><CODE>addPropertyChangeListener(PropertyChangeListener)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOriginal()"><!-- --></A><H3> |
| getOriginal</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A> <B>getOriginal</B>()</PRE> |
| <DL> |
| <DD>Returns the runtime instance that this working copy is |
| associated with. |
| <p> |
| For a runtime working copy created by a call to |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#createWorkingCopy()"><CODE>IRuntime.createWorkingCopy()</CODE></A>, |
| <code>this.getOriginal()</code> returns the original |
| runtime object. For a runtime working copy just created by |
| a call to <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html#createRuntime(java.lang.String, IProgressMonitor)"><CODE>IRuntimeType.createRuntime(String, IProgressMonitor)</CODE></A>, |
| <code>this.getOriginal()</code> returns <code>null</code>. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the associated runtime instance, or <code>null</code> if none</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLocation(IPath)"><!-- --></A><H3> |
| setLocation</H3> |
| <PRE> |
| void <B>setLocation</B>(IPath path)</PRE> |
| <DL> |
| <DD>Sets the absolute path in the local file system to the root of the runtime, |
| typically the installation directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the location of this runtime, or <code>null</code> if none<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getLocation()"><CODE>IRuntime.getLocation()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStub(boolean)"><!-- --></A><H3> |
| setStub</H3> |
| <PRE> |
| void <B>setStub</B>(boolean stub)</PRE> |
| <DL> |
| <DD>Returns whether this runtime is a stub (used for compilation only) |
| or a full runtime. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>stub</CODE> - <code>true</code> if this runtime is a stub, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(boolean, IProgressMonitor)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A> <B>save</B>(boolean force, |
| IProgressMonitor monitor) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Commits the changes made in this working copy. If there is |
| no extant runtime instance with a matching id and runtime |
| type, this will create a runtime instance with attributes |
| taken from this working copy, and return that object. |
| <p> |
| If there an existing runtime instance with a matching id and |
| runtime type, this will change the runtime instance accordingly. |
| The returned runtime will be the same runtime this is returned |
| from getOriginal(), after the changes have been applied. |
| Otherwise, this method will return a newly created runtime. |
| </p> |
| Runtimes can be saved even when they have invalid properties. It |
| is the clients responsibility to call validate() or check the |
| properties before saving. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>force</CODE> - <code>true</code> to force the save, or <code>false</code> |
| otherwise<DD><CODE>monitor</CODE> - a progress monitor, or <code>null</code> if progress |
| reporting and cancellation are not desired |
| <DT><B>Returns:</B><DD>a new runtime instance |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - if the save could not be completed<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeWorkingCopy.html#SAVE_CONFLICT"><CODE>SAVE_CONFLICT</CODE></A></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/IRuntimeWorkingCopy.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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/server/core/IRuntimeWorkingCopy.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IRuntimeWorkingCopy.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
