| <!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_12) on Fri May 30 11:15:48 CDT 2008 --> |
| <TITLE> |
| IJsGlobalScopeContainerInitializer |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IJsGlobalScopeContainerInitializer interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="IJsGlobalScopeContainerInitializer"; |
| } |
| </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/IJsGlobalScopeContainerInitializer.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILocalVariable.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJsGlobalScopeContainerInitializer.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | 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.jsdt.core</FONT> |
| <BR> |
| Interface IJsGlobalScopeContainerInitializer</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/libraries/BasicBrowserLibraryJsGlobalScopeContainerInitializer.html" title="class in org.eclipse.wst.jsdt.libraries">BasicBrowserLibraryJsGlobalScopeContainerInitializer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/libraries/FireFoxLibInitializer.html" title="class in org.eclipse.wst.jsdt.core.compiler.libraries">FireFoxLibInitializer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/libraries/InternetExplorerLibInitializer.html" title="class in org.eclipse.wst.jsdt.core.compiler.libraries">InternetExplorerLibInitializer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/JsGlobalScopeContainerInitializer.html" title="class in org.eclipse.wst.jsdt.core">JsGlobalScopeContainerInitializer</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IJsGlobalScopeContainerInitializer</B></DL> |
| </PRE> |
| |
| <P> |
| Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#allowAttachJsDoc()">allowAttachJsDoc</A></B>()</CODE> |
| |
| <BR> |
| </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/jsdt/core/IJsGlobalScopeContainerInitializer.html#canUpdateJsGlobalScopeContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">canUpdateJsGlobalScopeContainer</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this container initializer can be requested to perform updates |
| on its own container values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#containerSuperTypes()">containerSuperTypes</A></B>()</CODE> |
| |
| <BR> |
| returns a String of all SuperTypes provided by this library.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getComparisonID(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">getComparisonID</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Returns an object which identifies a container for comparison purpose.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getDescription(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">getDescription</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Returns a readable description for a container path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core">IJsGlobalScopeContainer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getFailureContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">getFailureContainer</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Returns a includepath container that is used after this initializer failed to bind a includepath container |
| to a <code>IJsGlobalScopeContainer</code> for the given project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.net.URI</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getHostPath(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">getHostPath</A></B>(IPath path, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getInferenceID()">getInferenceID</A></B>()</CODE> |
| |
| <BR> |
| Get the id of the inference provider for this library</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/libraries/LibraryLocation.html" title="interface in org.eclipse.wst.jsdt.core.compiler.libraries">LibraryLocation</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html#getLibraryLocation()">getLibraryLocation</A></B>()</CODE> |
| |
| <BR> |
| </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/jsdt/core/IJsGlobalScopeContainerInitializer.html#initialize(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)">initialize</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| Binds a includepath container to a <code>IJsGlobalScopeContainer</code> for a given project, |
| or silently fails if unable to do so.</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/jsdt/core/IJsGlobalScopeContainerInitializer.html#removeFromProject(org.eclipse.wst.jsdt.core.IJavaScriptProject)">removeFromProject</A></B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</CODE> |
| |
| <BR> |
| </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/jsdt/core/IJsGlobalScopeContainerInitializer.html#requestJsGlobalScopeContainerUpdate(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IJsGlobalScopeContainer)">requestJsGlobalScopeContainerUpdate</A></B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core">IJsGlobalScopeContainer</A> containerSuggestion)</CODE> |
| |
| <BR> |
| Request a registered container definition to be updated according to a container suggestion.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="initialize(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| void <B>initialize</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Binds a includepath container to a <code>IJsGlobalScopeContainer</code> for a given project, |
| or silently fails if unable to do so. |
| <p> |
| A container is identified by a container path, which must be formed of two segments. |
| The first segment is used as a unique identifier (which this initializer did register onto), and |
| the second segment can be used as an additional hint when performing the resolution. |
| <p> |
| The initializer is invoked if a container path needs to be resolved for a given project, and no |
| value for it was recorded so far. The implementation of the initializer would typically set the |
| corresponding container using <code>JavaScriptCore#setJsGlobalScopeContainer</code>. |
| <p> |
| A container initialization can be indirectly performed while attempting to resolve a project |
| includepath using <code>IJavaScriptProject#getResolvedClasspath(</code>; or directly when using |
| <code>JavaScriptCore#getJsGlobalScopeContainer</code>. During the initialization process, any attempt |
| to further obtain the same container will simply return <code>null</code> so as to avoid an |
| infinite regression of initializations. |
| <p> |
| A container initialization may also occur indirectly when setting a project includepath, as the operation |
| needs to resolve the includepath for validation purpose. While the operation is in progress, a referenced |
| container initializer may be invoked. If the initializer further tries to access the referring project includepath, |
| it will not see the new assigned includepath until the operation has completed. Note that once the JavaScript |
| change notification occurs (at the end of the operation), the model has been updated, and the project |
| includepath can be queried normally. |
| <p> |
| This method is called by the JavaScript model to give the party that defined |
| this particular kind of includepath container the chance to install |
| includepath container objects that will be used to convert includepath |
| container entries into simpler includepath entries. The method is typically |
| called exactly once for a given JavaScript project and includepath container |
| entry. This method must not be called by other clients. |
| <p> |
| There are a wide variety of conditions under which this method may be |
| invoked. To ensure that the implementation does not interfere with |
| correct functioning of the JavaScript model, the implementation should use |
| only the following JavaScript model APIs: |
| <ul> |
| <li><CODE>JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)</CODE></li> |
| <li><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getJsGlobalScopeContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><CODE>JavaScriptCore.getJsGlobalScopeContainer(IPath, IJavaScriptProject)</CODE></A></li> |
| <li><CODE>JavaScriptCore#create(org.eclipse.core.resources.IWorkspaceRoot)</CODE></li> |
| <li><CODE>JavaScriptCore#create(org.eclipse.core.resources.IProject)</CODE></li> |
| <li><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptModel.html#getJavaScriptProjects()"><CODE>IJavaScriptModel.getJavaScriptProjects()</CODE></A></li> |
| <li>JavaScript element operations marked as "handle-only"</li> |
| </ul> |
| The effects of using other JavaScript model APIs are unspecified. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - a two-segment path (ID/hint) identifying the container that needs |
| to be resolved<DD><CODE>project</CODE> - the JavaScript project in which context the container is to be resolved. |
| This allows generic containers to be bound with project specific values. |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - if an exception occurs during the initialization<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#getJsGlobalScopeContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><CODE>JavaScriptCore.getJsGlobalScopeContainer(IPath, IJavaScriptProject)</CODE></A>, |
| <CODE>JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)</CODE>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core"><CODE>IJsGlobalScopeContainer</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="canUpdateJsGlobalScopeContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| canUpdateJsGlobalScopeContainer</H3> |
| <PRE> |
| boolean <B>canUpdateJsGlobalScopeContainer</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this container initializer can be requested to perform updates |
| on its own container values. If so, then an update request will be performed using |
| <code>JsGlobalScopeContainerInitializer#requestJsGlobalScopeContainerUpdate</code>/ |
| <p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - the path of the container which requires to be updated<DD><CODE>project</CODE> - the project for which the container is to be updated |
| <DT><B>Returns:</B><DD>returns <code>true</code> if the container can be updated</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="requestJsGlobalScopeContainerUpdate(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IJsGlobalScopeContainer)"><!-- --></A><H3> |
| requestJsGlobalScopeContainerUpdate</H3> |
| <PRE> |
| void <B>requestJsGlobalScopeContainerUpdate</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core">IJsGlobalScopeContainer</A> containerSuggestion) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Request a registered container definition to be updated according to a container suggestion. The container suggestion |
| only acts as a place-holder to pass along the information to update the matching container definition(s) held by the |
| container initializer. In particular, it is not expected to store the container suggestion as is, but rather adjust |
| the actual container definition based on suggested changes. |
| <p> |
| IMPORTANT: In reaction to receiving an update request, a container initializer will update the corresponding |
| container definition (after reconciling changes) at its earliest convenience, using |
| <code>JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], IProgressMonitor)</code>. |
| Until it does so, the update will not be reflected in the JavaScript Model. |
| <p> |
| In order to anticipate whether the container initializer allows to update its containers, the predicate |
| <code>JavaScriptCore#canUpdateJsGlobalScopeContainer</code> should be used. |
| <p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - the path of the container which requires to be updated<DD><CODE>project</CODE> - the project for which the container is to be updated<DD><CODE>containerSuggestion</CODE> - a suggestion to update the corresponding container definition |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - when <code>JavaScriptCore#setJsGlobalScopeContainer</code> would throw any.<DT><B>See Also:</B><DD><CODE>JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)</CODE>, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/JsGlobalScopeContainerInitializer.html#canUpdateJsGlobalScopeContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><CODE>JsGlobalScopeContainerInitializer.canUpdateJsGlobalScopeContainer(IPath, IJavaScriptProject)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDescription(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| getDescription</H3> |
| <PRE> |
| java.lang.String <B>getDescription</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD>Returns a readable description for a container path. A readable description for a container path can be |
| used for improving the display of references to container, without actually needing to resolve them. |
| A good implementation should answer a description consistent with the description of the associated |
| target container (see <code>IJsGlobalScopeContainer.getDescription()</code>). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - the path of the container which requires a readable description<DD><CODE>project</CODE> - the project from which the container is referenced |
| <DT><B>Returns:</B><DD>a string description of the container</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFailureContainer(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| getFailureContainer</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core">IJsGlobalScopeContainer</A> <B>getFailureContainer</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD>Returns a includepath container that is used after this initializer failed to bind a includepath container |
| to a <code>IJsGlobalScopeContainer</code> for the given project. A non-<code>null</code> |
| failure container indicates that there will be no more request to initialize the given container |
| for the given project. |
| <p> |
| By default a non-<code>null</code> failure container with no includepath entries is returned. |
| Clients wishing to get a chance to run the initializer again should override this method |
| and return <code>null</code>. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - the path of the container which failed to initialize<DD><CODE>project</CODE> - the project from which the container is referenced |
| <DT><B>Returns:</B><DD>the default failure container, or <code>null</code> if wishing to run the initializer again</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getComparisonID(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| getComparisonID</H3> |
| <PRE> |
| java.lang.Object <B>getComparisonID</B>(IPath containerPath, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD>Returns an object which identifies a container for comparison purpose. This allows |
| to eliminate redundant containers when accumulating includepath entries (e.g. |
| runtime includepath computation). When requesting a container comparison ID, one |
| should ensure using its corresponding container initializer. Indeed, a random container |
| initializer cannot be held responsible for determining comparison IDs for arbitrary |
| containers. |
| <p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>containerPath</CODE> - the path of the container which is being checked<DD><CODE>project</CODE> - the project for which the container is to being checked |
| <DT><B>Returns:</B><DD>returns an Object identifying the container for comparison</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHostPath(IPath, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| getHostPath</H3> |
| <PRE> |
| java.net.URI <B>getHostPath</B>(IPath path, |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLibraryLocation()"><!-- --></A><H3> |
| getLibraryLocation</H3> |
| <PRE> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/compiler/libraries/LibraryLocation.html" title="interface in org.eclipse.wst.jsdt.core.compiler.libraries">LibraryLocation</A> <B>getLibraryLocation</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="allowAttachJsDoc()"><!-- --></A><H3> |
| allowAttachJsDoc</H3> |
| <PRE> |
| boolean <B>allowAttachJsDoc</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containerSuperTypes()"><!-- --></A><H3> |
| containerSuperTypes</H3> |
| <PRE> |
| java.lang.String[] <B>containerSuperTypes</B>()</PRE> |
| <DL> |
| <DD>returns a String of all SuperTypes provided by this library. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInferenceID()"><!-- --></A><H3> |
| getInferenceID</H3> |
| <PRE> |
| java.lang.String <B>getInferenceID</B>()</PRE> |
| <DL> |
| <DD>Get the id of the inference provider for this library |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>inference provider id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFromProject(org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3> |
| removeFromProject</H3> |
| <PRE> |
| void <B>removeFromProject</B>(<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A> project)</PRE> |
| <DL> |
| <DD><DL> |
| </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/IJsGlobalScopeContainerInitializer.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJsGlobalScopeContainer.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILocalVariable.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IJsGlobalScopeContainerInitializer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IJsGlobalScopeContainerInitializer.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
