public interface IJsGlobalScopeContainerInitializer
Modifier and Type | Method and Description |
---|---|
boolean |
allowAttachJsDoc() |
boolean |
canUpdateJsGlobalScopeContainer(IPath containerPath,
IJavaScriptProject project)
Returns
true if this container initializer can be requested to perform updates
on its own container values. |
java.lang.String[] |
containerSuperTypes()
returns a String of all SuperTypes provided by this library.
|
java.lang.Object |
getComparisonID(IPath containerPath,
IJavaScriptProject project)
Returns an object which identifies a container for comparison purpose.
|
java.lang.String |
getDescription(IPath containerPath,
IJavaScriptProject project)
Returns a readable description for a container path.
|
IJsGlobalScopeContainer |
getFailureContainer(IPath containerPath,
IJavaScriptProject project)
Returns a includepath container that is used after this initializer failed to bind a includepath container
to a
IJsGlobalScopeContainer for the given project. |
java.net.URI |
getHostPath(IPath path,
IJavaScriptProject project) |
java.lang.String |
getInferenceID()
Get the id of the inference provider for this library
|
LibraryLocation |
getLibraryLocation() |
void |
initialize(IPath containerPath,
IJavaScriptProject project)
Binds a includepath container to a
IJsGlobalScopeContainer for a given project,
or silently fails if unable to do so. |
void |
removeFromProject(IJavaScriptProject project) |
void |
requestJsGlobalScopeContainerUpdate(IPath containerPath,
IJavaScriptProject project,
IJsGlobalScopeContainer containerSuggestion)
Request a registered container definition to be updated according to a container suggestion.
|
void initialize(IPath containerPath, IJavaScriptProject project) throws CoreException
IJsGlobalScopeContainer
for a given project,
or silently fails if unable to do so.
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.
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 JavaScriptCore#setJsGlobalScopeContainer
.
A container initialization can be indirectly performed while attempting to resolve a project
includepath using IJavaScriptProject#getResolvedClasspath(
; or directly when using
JavaScriptCore#getJsGlobalScopeContainer
. During the initialization process, any attempt
to further obtain the same container will simply return null
so as to avoid an
infinite regression of initializations.
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.
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.
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:
JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)
JavaScriptCore.getJsGlobalScopeContainer(IPath, IJavaScriptProject)
JavaScriptCore#create(org.eclipse.core.resources.IWorkspaceRoot)
JavaScriptCore#create(org.eclipse.core.resources.IProject)
IJavaScriptModel.getJavaScriptProjects()
containerPath
- a two-segment path (ID/hint) identifying the container that needs
to be resolvedproject
- the JavaScript project in which context the container is to be resolved.
This allows generic containers to be bound with project specific values.CoreException
- if an exception occurs during the initializationJavaScriptCore.getJsGlobalScopeContainer(IPath, IJavaScriptProject)
,
JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)
,
IJsGlobalScopeContainer
boolean canUpdateJsGlobalScopeContainer(IPath containerPath, IJavaScriptProject project)
true
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
JsGlobalScopeContainerInitializer#requestJsGlobalScopeContainerUpdate
/
containerPath
- the path of the container which requires to be updatedproject
- the project for which the container is to be updatedtrue
if the container can be updatedvoid requestJsGlobalScopeContainerUpdate(IPath containerPath, IJavaScriptProject project, IJsGlobalScopeContainer containerSuggestion) throws CoreException
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
JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], IProgressMonitor)
.
Until it does so, the update will not be reflected in the JavaScript Model.
In order to anticipate whether the container initializer allows to update its containers, the predicate
JavaScriptCore#canUpdateJsGlobalScopeContainer
should be used.
containerPath
- the path of the container which requires to be updatedproject
- the project for which the container is to be updatedcontainerSuggestion
- a suggestion to update the corresponding container definitionCoreException
- when JavaScriptCore#setJsGlobalScopeContainer
would throw any.JavaScriptCore#setJsGlobalScopeContainer(IPath, IJavaScriptProject[], IJsGlobalScopeContainer[], org.eclipse.core.runtime.IProgressMonitor)
,
JsGlobalScopeContainerInitializer.canUpdateJsGlobalScopeContainer(IPath, IJavaScriptProject)
java.lang.String getDescription(IPath containerPath, IJavaScriptProject project)
IJsGlobalScopeContainer.getDescription()
).containerPath
- the path of the container which requires a readable descriptionproject
- the project from which the container is referencedIJsGlobalScopeContainer getFailureContainer(IPath containerPath, IJavaScriptProject project)
IJsGlobalScopeContainer
for the given project. A non-null
failure container indicates that there will be no more request to initialize the given container
for the given project.
By default a non-null
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 null
.
containerPath
- the path of the container which failed to initializeproject
- the project from which the container is referencednull
if wishing to run the initializer againjava.lang.Object getComparisonID(IPath containerPath, IJavaScriptProject project)
containerPath
- the path of the container which is being checkedproject
- the project for which the container is to being checkedjava.net.URI getHostPath(IPath path, IJavaScriptProject project)
LibraryLocation getLibraryLocation()
boolean allowAttachJsDoc()
java.lang.String[] containerSuperTypes()
java.lang.String getInferenceID()
void removeFromProject(IJavaScriptProject project)
Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.