|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IJavaScriptUnit
Represents an entire JavaScript file (source file with one of the
JavaScript-like extensions
).
JavaScriptUnit elements need to be opened before they can be navigated or manipulated.
The children are of type IPackageDeclaration
,
IImportContainer
,IFunction
,IField
, and IType
,
and appear in the order in which they are declared in the source.
If a source file cannot be parsed, its structure remains unknown.
Use IJavaScriptElement.isStructureKnown()
to determine whether this is
the case.
This interface is not intended to be implemented by clients.
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.
Field Summary | |
---|---|
static int |
ENABLE_BINDINGS_RECOVERY
Constant indicating that a reconcile operation should enable the bindings recovery |
static int |
ENABLE_STATEMENTS_RECOVERY
Constant indicating that a reconcile operation should enable the statements recovery. |
static int |
FORCE_PROBLEM_DETECTION
Constant indicating that a reconcile operation should recompute the problems even if the source hasn't changed. |
static int |
NO_AST
Constant indicating that a reconcile operation should not return an AST. |
Fields inherited from interface org.eclipse.wst.jsdt.core.IJavaScriptElement |
---|
CLASS_FILE, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVASCRIPT_MODEL, JAVASCRIPT_PROJECT, JAVASCRIPT_UNIT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER |
Method Summary | |
---|---|
void |
becomeWorkingCopy(IProblemRequestor problemRequestor,
IProgressMonitor monitor)
Deprecated. Use becomeWorkingCopy(IProgressMonitor) instead.
Note that if this deprecated method is used, problems will be reported to the given problem requestor
as well as the problem requestor returned by the working copy owner (if not null). |
void |
becomeWorkingCopy(IProgressMonitor monitor)
Changes this javaScript file handle into a working copy. |
void |
commitWorkingCopy(boolean force,
IProgressMonitor monitor)
Commits the contents of this working copy to its underlying resource. |
IField |
createField(java.lang.String contents,
IJavaScriptElement sibling,
boolean force,
IProgressMonitor monitor)
Creates and returns a var in this javaScript file with the given contents. |
IImportDeclaration |
createImport(java.lang.String name,
IJavaScriptElement sibling,
int flags,
IProgressMonitor monitor)
Creates and returns an import declaration in this javaScript file with the given name. |
IImportDeclaration |
createImport(java.lang.String name,
IJavaScriptElement sibling,
IProgressMonitor monitor)
Creates and returns an non-static import declaration in this javaScript file with the given name. |
IFunction |
createMethod(java.lang.String contents,
IJavaScriptElement sibling,
boolean force,
IProgressMonitor monitor)
Creates and returns a function in this javaScript file with the given contents. |
IPackageDeclaration |
createPackageDeclaration(java.lang.String name,
IProgressMonitor monitor)
Creates and returns a package declaration in this javaScript file with the given package name. |
IType |
createType(java.lang.String contents,
IJavaScriptElement sibling,
boolean force,
IProgressMonitor monitor)
Creates and returns a type in this javaScript file with the given contents. |
void |
discardWorkingCopy()
Changes this javaScript file in working copy mode back to its original mode. |
IJavaScriptElement[] |
findElements(IJavaScriptElement element)
Finds the elements in this javaScript file that correspond to the given element. |
IFunction[] |
findFunctions(IFunction function)
Finds the function in this javaScript file that correspond to the given function. |
IJavaScriptUnit |
findWorkingCopy(WorkingCopyOwner owner)
Finds the working copy for this javaScript file, given a WorkingCopyOwner . |
IType[] |
getAllTypes()
Returns all types declared in this javaScript file in the order in which they appear in the source. |
IImportDeclaration |
getImport(java.lang.String name)
Returns the first import declaration in this javaScript file with the given name. |
IImportContainer |
getImportContainer()
Returns the import container for this javaScript file. |
IImportDeclaration[] |
getImports()
Returns the import declarations in this javaScript file in the order in which they appear in the source. |
WorkingCopyOwner |
getOwner()
Returns the working copy owner of this working copy. |
IPackageDeclaration |
getPackageDeclaration(java.lang.String name)
Returns the first package declaration in this javaScript file with the given package name (there normally is at most one package declaration). |
IPackageDeclaration[] |
getPackageDeclarations()
Returns the package declarations in this javaScript file in the order in which they appear in the source. |
IJavaScriptUnit |
getPrimary()
Returns the primary javaScript file (whose owner is the primary owner) this working copy was created from, or this javaScript file if this a primary javaScript file. |
IType[] |
getTypes()
Returns the top-level types declared in this javaScript file in the order in which they appear in the source. |
IJavaScriptUnit |
getWorkingCopy(IProgressMonitor monitor)
Returns a new working copy of this javaScript file if it is a primary javaScript file, or this javaScript file if it is already a non-primary working copy. |
IJavaScriptUnit |
getWorkingCopy(WorkingCopyOwner owner,
IProblemRequestor problemRequestor,
IProgressMonitor monitor)
Deprecated. Use ITypeRoot.getWorkingCopy(WorkingCopyOwner, IProgressMonitor) instead.
Note that if this deprecated method is used, problems will be reported on the passed problem requester
as well as on the problem requestor returned by the working copy owner (if not null). |
boolean |
hasResourceChanged()
Returns whether the resource of this working copy has changed since the inception of this working copy. |
boolean |
isWorkingCopy()
Returns whether this element is a working copy. |
JavaScriptUnit |
reconcile(int astLevel,
boolean forceProblemDetection,
boolean enableStatementsRecovery,
WorkingCopyOwner owner,
IProgressMonitor monitor)
Reconciles the contents of this working copy, sends out a JavaScript delta notification indicating the nature of the change of the working copy since the last time it was either reconciled or made consistent ( IOpenable.makeConsistent(IProgressMonitor) ), and returns a
javaScript file AST if requested. |
JavaScriptUnit |
reconcile(int astLevel,
boolean forceProblemDetection,
WorkingCopyOwner owner,
IProgressMonitor monitor)
Reconciles the contents of this working copy, sends out a JavaScript delta notification indicating the nature of the change of the working copy since the last time it was either reconciled or made consistent ( IOpenable.makeConsistent(IProgressMonitor) ), and returns a
javaScript file AST if requested. |
JavaScriptUnit |
reconcile(int astLevel,
int reconcileFlags,
WorkingCopyOwner owner,
IProgressMonitor monitor)
Reconciles the contents of this working copy, sends out a JavaScript delta notification indicating the nature of the change of the working copy since the last time it was either reconciled or made consistent ( IOpenable.makeConsistent(IProgressMonitor) ), and returns a
javaScript file AST if requested. |
void |
restore()
Restores the contents of this working copy to the current contents of this working copy's original element. |
Methods inherited from interface org.eclipse.wst.jsdt.core.ITypeRoot |
---|
findPrimaryType, getElementAt, getWorkingCopy |
Methods inherited from interface org.eclipse.wst.jsdt.core.IJavaScriptElement |
---|
exists, getAncestor, getAttachedJavadoc, getCommonSuperType, getCorrespondingResource, getDisplayName, getElementName, getElementType, getHandleIdentifier, getHostPath, getJavaScriptModel, getJavaScriptProject, getOpenable, getParent, getPath, getPrimaryElement, getResource, getSchedulingRule, getUnderlyingResource, isReadOnly, isStructureKnown, isVirtual |
Methods inherited from interface org.eclipse.wst.jsdt.core.ILookupScope |
---|
newNameLookup, newNameLookup, newSearchableNameEnvironment, newSearchableNameEnvironment |
Methods inherited from interface org.eclipse.wst.jsdt.core.IParent |
---|
getChildren, hasChildren |
Methods inherited from interface org.eclipse.wst.jsdt.core.IOpenable |
---|
close, findRecommendedLineSeparator, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, open, save |
Methods inherited from interface org.eclipse.wst.jsdt.core.ISourceReference |
---|
exists, getSource, getSourceRange |
Methods inherited from interface org.eclipse.wst.jsdt.core.ICodeAssist |
---|
codeComplete, codeComplete, codeSelect, codeSelect |
Methods inherited from interface org.eclipse.wst.jsdt.core.IFunctionContainer |
---|
getField, getFields, getFunction, getFunctions, getMethods, getType |
Methods inherited from interface org.eclipse.wst.jsdt.core.IWorkingCopy |
---|
commit, destroy, findPrimaryType, findSharedWorkingCopy, getOriginal, getOriginalElement, getSharedWorkingCopy, getWorkingCopy, getWorkingCopy, isBasedOn, reconcile, reconcile |
Methods inherited from interface org.eclipse.wst.jsdt.core.ISourceManipulation |
---|
copy, delete, move, rename |
Field Detail |
---|
static final int NO_AST
static final int FORCE_PROBLEM_DETECTION
static final int ENABLE_STATEMENTS_RECOVERY
ASTParser.setStatementsRecovery(boolean)
,
Constant Field Valuesstatic final int ENABLE_BINDINGS_RECOVERY
ASTParser.setBindingsRecovery(boolean)
,
IBinding.isRecovered()
,
Constant Field ValuesMethod Detail |
---|
void becomeWorkingCopy(IProblemRequestor problemRequestor, IProgressMonitor monitor) throws JavaScriptModelException
becomeWorkingCopy(IProgressMonitor)
instead.
Note that if this deprecated method is used, problems will be reported to the given problem requestor
as well as the problem requestor returned by the working copy owner (if not null).
IBuffer
is
created using this javaScript file handle's owner. Uses the primary owner is none was
specified when this javaScript file handle was created.
When switching to working copy mode, problems are reported to given
IProblemRequestor
. Note that once in working copy mode, the given
IProblemRequestor
is ignored. Only the original IProblemRequestor
is used to report subsequent problems.
Once in working copy mode, changes to this javaScript file or its children are done in memory.
Only the new buffer is affected. Using commitWorkingCopy(boolean, IProgressMonitor)
will bring the underlying resource in sync with this javaScript file.
If this javaScript file was already in working copy mode, an internal counter is incremented and no
other action is taken on this javaScript file. To bring this javaScript file back into the original mode
(where it reflects the underlying resource), discardWorkingCopy()
must be call as many
times as becomeWorkingCopy(IProblemRequestor, IProgressMonitor)
.
problemRequestor
- a requestor which will get notified of problems detected during
reconciling as they are discovered. The requestor can be set to null
indicating
that the client is not interested in problems.monitor
- a progress monitor used to report progress while opening this javaScript file
or null
if no progress should be reported
JavaScriptModelException
- if this javaScript file could not become a working copy.discardWorkingCopy()
void becomeWorkingCopy(IProgressMonitor monitor) throws JavaScriptModelException
IBuffer
is
created using this javaScript file handle's owner. Uses the primary owner if none was
specified when this javaScript file handle was created.
When switching to working copy mode, problems are reported to the problem requestor
of the working copy owner
.
Once in working copy mode, changes to this javaScript file or its children are done in memory.
Only the new buffer is affected. Using commitWorkingCopy(boolean, IProgressMonitor)
will bring the underlying resource in sync with this javaScript file.
If this javaScript file was already in working copy mode, an internal counter is incremented and no
other action is taken on this javaScript file. To bring this javaScript file back into the original mode
(where it reflects the underlying resource), discardWorkingCopy()
must be call as many
times as becomeWorkingCopy(IProblemRequestor, IProgressMonitor)
.
monitor
- a progress monitor used to report progress while opening this javaScript file
or null
if no progress should be reported
JavaScriptModelException
- if this javaScript file could not become a working copy.discardWorkingCopy()
void commitWorkingCopy(boolean force, IProgressMonitor monitor) throws JavaScriptModelException
It is possible that the contents of the original resource have changed
since this working copy was created, in which case there is an update conflict.
The value of the force
parameter effects the resolution of
such a conflict:
true
- in this case the contents of this working copy are applied to
the underlying resource even though this working copy was created before
a subsequent change in the resourcefalse
- in this case a JavaScriptModelException
is thrown
force
- a flag to handle the cases when the contents of the original resource have changed
since this working copy was createdmonitor
- the given progress monitor
JavaScriptModelException
- if this working copy could not commit. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
IImportDeclaration createImport(java.lang.String name, IJavaScriptElement sibling, IProgressMonitor monitor) throws JavaScriptModelException
createImport(name, Flags.AccDefault, sibling, monitor)
.
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the name of the import declaration to addsibling
- the existing element which the import declaration will be inserted immediately before (if
null
, then this import will be inserted as the last import declaration.monitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
createImport(String, IJavaScriptElement, int, IProgressMonitor)
IImportDeclaration createImport(java.lang.String name, IJavaScriptElement sibling, int flags, IProgressMonitor monitor) throws JavaScriptModelException
Optionally, the new element can be positioned before the specified sibling. If no sibling is specified, the element will be inserted as the last import declaration in this javaScript file.
If the javaScript file already includes the specified import declaration, the import is not generated (it does not generate duplicates).
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the name of the import declarationsibling
- the existing element which the import declaration will be inserted immediately before (if
null
, then this import will be inserted as the last import declaration.flags
- Flags.AccStatic
for static imports, or
Flags.AccDefault
for regular imports; other modifier flags
are ignoredmonitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
Flags
IPackageDeclaration createPackageDeclaration(java.lang.String name, IProgressMonitor monitor) throws JavaScriptModelException
If the javaScript file already includes the specified package declaration, it is not generated (it does not generate duplicates).
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the name of the package declaration to addmonitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
IType createType(java.lang.String contents, IJavaScriptElement sibling, boolean force, IProgressMonitor monitor) throws JavaScriptModelException
Optionally, the new type can be positioned before the specified
sibling. If sibling
is null
, the type will be appended
to the end of this javaScript file.
It is possible that a type with the same name already exists in this javaScript file.
The value of the force
parameter effects the resolution of
such a conflict:
true
- in this case the type is created with the new contentsfalse
- in this case a JavaScriptModelException
is thrownNote: This Method only applies to ECMAScript 4 which is not yet supported
contents
- the source contents of the type declaration to add.sibling
- the existing element which the type will be inserted immediately before (if
null
, then this type will be inserted as the last type declaration.force
- a boolean
flag indicating how to deal with duplicatesmonitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
IField createField(java.lang.String contents, IJavaScriptElement sibling, boolean force, IProgressMonitor monitor) throws JavaScriptModelException
Optionally, the new var can be positioned before the specified
sibling. If sibling
is null
, the var will be appended
to the end of this javaScript file.
It is possible that a var with the same name already exists in this javaScript file.
The value of the force
parameter effects the resolution of
such a conflict:
true
- in this case the var is created with the new contentsfalse
- in this case a JavaScriptModelException
is thrown
contents
- the source contents of the var declaration to add.sibling
- the existing element which the var will be inserted immediately before (if
null
, then this var will be inserted as the last var declaration.force
- a boolean
flag indicating how to deal with duplicatesmonitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
IFunction createMethod(java.lang.String contents, IJavaScriptElement sibling, boolean force, IProgressMonitor monitor) throws JavaScriptModelException
Optionally, the new function can be positioned before the specified
sibling. If sibling
is null
, the function will be appended
to the end of this javaScript file.
It is possible that a function with the same name already exists in this javaScript file.
The value of the force
parameter effects the resolution of
such a conflict:
true
- in this case the function is created with the new contentsfalse
- in this case a JavaScriptModelException
is thrown
contents
- the source contents of the function declaration to add.sibling
- the existing element which the function will be inserted immediately before (if
null
, then this function will be inserted as the last function declaration.force
- a boolean
flag indicating how to deal with duplicatesmonitor
- the progress monitor to notify
JavaScriptModelException
- if the element could not be created. Reasons include:
org.eclipse.core.runtime.CoreException
occurred while updating an underlying resource
void discardWorkingCopy() throws JavaScriptModelException
This has no effect if this javaScript file was not in working copy mode.
If becomeWorkingCopy(org.eclipse.wst.jsdt.core.IProblemRequestor, IProgressMonitor)
was called several times on this
javaScript file, discardWorkingCopy()
must be called as
many times before it switches back to the original mode.
JavaScriptModelException
- if this working copy could not return in its original mode.becomeWorkingCopy(IProblemRequestor, IProgressMonitor)
IJavaScriptElement[] findElements(IJavaScriptElement element)
null
if no such javaScript elements can be found
or if the given element is not included in a javaScript file.
findElements
in interface IWorkingCopy
element
- the given element
IJavaScriptUnit findWorkingCopy(WorkingCopyOwner owner)
WorkingCopyOwner
.
If no working copy has been created for this javaScript file associated with this
working copy owner, returns null
.
Users of this method must not destroy the resulting working copy.
owner
- the given WorkingCopyOwner
null
if noneWorkingCopyOwner
IType[] getAllTypes() throws JavaScriptModelException
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIImportDeclaration getImport(java.lang.String name)
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the name of the import to find
IImportContainer getImportContainer()
Note: This Method only applies to ECMAScript 4 which is not yet supported
IImportDeclaration[] getImports() throws JavaScriptModelException
Note: This Method only applies to ECMAScript 4 which is not yet supported
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIJavaScriptUnit getPrimary()
Note that the returned primary javaScript file can be in working copy mode.
WorkingCopyOwner getOwner()
null
IPackageDeclaration getPackageDeclaration(java.lang.String name)
Note: This Method only applies to ECMAScript 4 which is not yet supported
name
- the name of the package declaration
IPackageDeclaration[] getPackageDeclarations() throws JavaScriptModelException
Note: This Method only applies to ECMAScript 4 which is not yet supported
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIType[] getTypes() throws JavaScriptModelException
Note: This Method only applies to ECMAScript 4 which is not yet supported
JavaScriptModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIJavaScriptUnit getWorkingCopy(IProgressMonitor monitor) throws JavaScriptModelException
Note: if intending to share a working copy amongst several clients, then
getWorkingCopy(WorkingCopyOwner, IProblemRequestor, IProgressMonitor)
should be used instead.
When the working copy instance is created, an ADDED IJavaScriptElementDelta is reported on this working copy.
Once done with the working copy, users of this method must discard it using
discardWorkingCopy()
.
Since 2.1, a working copy can be created on a not-yet existing compilation unit. In particular, such a working copy can then be committed in order to create the corresponding javaScript file.
monitor
- a progress monitor used to report progress while opening this javaScript file
or null
if no progress should be reported
JavaScriptModelException
- if the contents of this element can
not be determined.IJavaScriptUnit getWorkingCopy(WorkingCopyOwner owner, IProblemRequestor problemRequestor, IProgressMonitor monitor) throws JavaScriptModelException
ITypeRoot.getWorkingCopy(WorkingCopyOwner, IProgressMonitor)
instead.
Note that if this deprecated method is used, problems will be reported on the passed problem requester
as well as on the problem requestor returned by the working copy owner (if not null).
Object.equals(java.lang.Object)
).
The life time of a shared working copy is as follows:
getWorkingCopy(WorkingCopyOwner, IProblemRequestor, IProgressMonitor)
creates a new working copy for this elementdiscardWorkingCopy()
decrements the internal counter.Note that the working copy owner will be used for the life time of this working copy, that is if the working copy is closed then reopened, this owner will be used. The buffer will be automatically initialized with the original's javaScript file content upon creation.
When the shared working copy instance is created, an ADDED IJavaScriptElementDelta is reported on this working copy.
Since 2.1, a working copy can be created on a not-yet existing compilation unit. In particular, such a working copy can then be committed in order to create the corresponding javaScript file.
owner
- the working copy owner that creates a buffer that is used to get the content
of the working copyproblemRequestor
- a requestor which will get notified of problems detected during
reconciling as they are discovered. The requestor can be set to null
indicating
that the client is not interested in problems.monitor
- a progress monitor used to report progress while opening this javaScript file
or null
if no progress should be reported
JavaScriptModelException
- if the contents of this element can
not be determined.boolean hasResourceChanged()
false
if this javaScript file is not in working copy mode.
boolean isWorkingCopy()
isWorkingCopy
in interface IWorkingCopy
JavaScriptUnit reconcile(int astLevel, boolean forceProblemDetection, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaScriptModelException
IOpenable.makeConsistent(IProgressMonitor)
), and returns a
javaScript file AST if requested.
It performs the reconciliation by locally caching the contents of the working copy, updating the contents, then creating a delta over the cached contents and the new contents, and finally firing this delta.
The boolean argument allows to force problem detection even if the working copy is already consistent.
This functionality allows to specify a working copy owner which is used
during problem detection. All references contained in the working copy are
resolved against other units; for which corresponding owned working copies
are going to take precedence over their original javaScript files. If
null
is passed in, then the primary working copy owner is used.
Compilation problems found in the new contents are notified through the
IProblemRequestor
interface which was passed at
creation, and no longer as transient markers.
Note: Since 3.0, added/removed/changed inner types generate change deltas.
If requested, a DOM AST representing the javaScript file is returned.
Its bindings are computed only if the problem requestor is active, or if the
problem detection is forced. This method returns null
if the
creation of the DOM AST was not requested, or if the requested level of AST
API is not supported, or if the working copy was already consistent.
This method doesn't perform statements recovery. To recover statements with syntax
errors, reconcile(int, boolean, boolean, WorkingCopyOwner, IProgressMonitor)
must be use.
astLevel
- either NO_AST
if no AST is wanted,
or the AST API level of the AST if one is wantedforceProblemDetection
- boolean indicating whether problem should be
recomputed even if the source hasn't changedowner
- the owner of working copies that take precedence over the
original javaScript files, or null
if the primary working
copy owner should be usedmonitor
- a progress monitor
null
if not requested,
or if the requested level of AST API is not supported,
or if the working copy was consistent
JavaScriptModelException
- if the contents of the original element
cannot be accessed. Reasons include:
JavaScriptUnit reconcile(int astLevel, boolean forceProblemDetection, boolean enableStatementsRecovery, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaScriptModelException
IOpenable.makeConsistent(IProgressMonitor)
), and returns a
javaScript file AST if requested.
It performs the reconciliation by locally caching the contents of the working copy, updating the contents, then creating a delta over the cached contents and the new contents, and finally firing this delta.
The boolean argument allows to force problem detection even if the working copy is already consistent.
This functionality allows to specify a working copy owner which is used
during problem detection. All references contained in the working copy are
resolved against other units; for which corresponding owned working copies
are going to take precedence over their original javaScript files. If
null
is passed in, then the primary working copy owner is used.
Compilation problems found in the new contents are notified through the
IProblemRequestor
interface which was passed at
creation, and no longer as transient markers.
Note: Since 3.0, added/removed/changed inner types generate change deltas.
If requested, a DOM AST representing the javaScript file is returned.
Its bindings are computed only if the problem requestor is active, or if the
problem detection is forced. This method returns null
if the
creation of the DOM AST was not requested, or if the requested level of AST
API is not supported, or if the working copy was already consistent.
If statements recovery is enabled then this method tries to rebuild statements with syntax error. Otherwise statements with syntax error won't be present in the returning DOM AST.
astLevel
- either NO_AST
if no AST is wanted,
or the AST API level of the AST if one is wantedforceProblemDetection
- boolean indicating whether problem should be
recomputed even if the source hasn't changedenableStatementsRecovery
- if true
statements recovery is enabled.owner
- the owner of working copies that take precedence over the
original javaScript files, or null
if the primary working
copy owner should be usedmonitor
- a progress monitor
null
if not requested,
or if the requested level of AST API is not supported,
or if the working copy was consistent
JavaScriptModelException
- if the contents of the original element
cannot be accessed. Reasons include:
JavaScriptUnit reconcile(int astLevel, int reconcileFlags, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaScriptModelException
IOpenable.makeConsistent(IProgressMonitor)
), and returns a
javaScript file AST if requested.
If the problem detection is forced by passing the FORCE_PROBLEM_DETECTION
bit in the given reconcile flag,
problem detection is run even if the working copy is already consistent.
It performs the reconciliation by locally caching the contents of the working copy, updating the contents, then creating a delta over the cached contents and the new contents, and finally firing this delta.
This functionality allows to specify a working copy owner which is used
during problem detection. All references contained in the working copy are
resolved against other units; for which corresponding owned working copies
are going to take precedence over their original javaScript files. If
null
is passed in, then the primary working copy owner is used.
Compilation problems found in the new contents are notified through the
IProblemRequestor
interface which was passed at
creation, and no longer as transient markers.
Note: Since 3.0, added/removed/changed inner types generate change deltas.
If requested, a DOM AST representing the javaScript file is returned.
Its bindings are computed only if the problem requestor is active, or if the
problem detection is forced. This method returns null
if the
creation of the DOM AST was not requested, or if the requested level of AST
API is not supported, or if the working copy was already consistent.
If statements recovery is enabled by passing the ENABLE_STATEMENTS_RECOVERY
bit in the given reconcile flag
then this method tries to rebuild statements with syntax error. Otherwise statements with syntax error won't be
present in the returning DOM AST.
If bindings recovery is enabled by passing the ENABLE_BINDINGS_RECOVERY
bit in the given reconcile flag
then this method tries to resolve bindings even if the type resolution contains errors.
The given reconcile flags is a bit-mask of the different constants (ENABLE_BINDINGS_RECOVERY
,
ENABLE_STATEMENTS_RECOVERY
, FORCE_PROBLEM_DETECTION
). Unspecified values are left for future use.
astLevel
- either NO_AST
if no AST is wanted,
or the AST API level of the AST if one is wantedreconcileFlags
- the given reconcile flagsowner
- the owner of working copies that take precedence over the
original javaScript files, or null
if the primary working
copy owner should be usedmonitor
- a progress monitor
null
if not requested,
or if the requested level of AST API is not supported,
or if the working copy was consistent
JavaScriptModelException
- if the contents of the original element
cannot be accessed. Reasons include:
FORCE_PROBLEM_DETECTION
,
ENABLE_BINDINGS_RECOVERY
,
ENABLE_STATEMENTS_RECOVERY
void restore() throws JavaScriptModelException
Note: This is the inverse of committing the content of the
working copy to the original element with commitWorkingCopy(boolean, IProgressMonitor)
.
restore
in interface IWorkingCopy
JavaScriptModelException
- if the contents of the original element
cannot be accessed. Reasons include:
IFunction[] findFunctions(IFunction function)
null
if no such function can be found
or if the given element is not included in a javaScript file.
function
- the given function
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |