Class EvaluationContextWrapper
- All Implemented Interfaces:
IEvaluationContext
-
Field Summary
-
Constructor Summary
ConstructorDescriptionEvaluationContextWrapper(EvaluationContext context, JavaProject project)
Creates a new wrapper around the given infrastructure evaluation context and project. -
Method Summary
Modifier and TypeMethodDescriptionReturns the global variables declared in this evaluation context.protected void
Checks to ensure that there is a previously built state.void
codeComplete(String codeSnippet, int position, CompletionRequestor requestor)
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.void
codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner)
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.void
codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner, org.eclipse.core.runtime.IProgressMonitor monitor)
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.void
codeComplete(String codeSnippet, int position, CompletionRequestor requestor, org.eclipse.core.runtime.IProgressMonitor monitor)
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.void
codeComplete(String codeSnippet, int position, ICodeCompletionRequestor requestor)
Deprecated.- use codeComplete(String, int, ICompletionRequestor) insteadvoid
codeComplete(String codeSnippet, int position, ICompletionRequestor requestor)
Deprecated.void
codeComplete(String codeSnippet, int position, ICompletionRequestor requestor, WorkingCopyOwner owner)
Deprecated.codeSelect(String codeSnippet, int offset, int length)
Resolves and returns a collection of Java elements corresponding to the source code at the given positions in the given code snippet.codeSelect(String codeSnippet, int offset, int length, WorkingCopyOwner owner)
Resolves and returns a collection of Java elements corresponding to the source code at the given positions in the given code snippet.void
deleteVariable(IGlobalVariable variable)
Deletes the given variable from this evaluation context.void
evaluateCodeSnippet(String codeSnippet, String[] localVariableTypeNames, String[] localVariableNames, int[] localVariableModifiers, IType declaringType, boolean isStatic, boolean isConstructorCall, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Evaluates the given code snippet in the context of a suspended thread.void
evaluateCodeSnippet(String codeSnippet, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Evaluates the given code snippet.void
evaluateVariable(IGlobalVariable variable, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Evaluates the given global variable.protected INameEnvironment
Returns a name environment for the last built state.String[]
Returns the import declarations for this evaluation context.Returns the infrastructure evaluation context.protected IRequestor
Returns a new infrastructure evaluation requestor instance.Returns the name of the package in which code snippets are to be compiled and run.protected IProblemFactory
Returns the problem factory to be used during evaluation.Returns the Java project this evaluation context was created for.char[]
protected void
Handles an install exception by throwing a Java Model exception.newVariable(String typeName, String name, String initializer)
Creates a new global variable with the given name, type, and initializer.void
setImports(String[] imports)
Sets the import declarations for this evaluation context.void
setPackageName(String packageName)
Sets the dot-separated name of the package in which code snippets are to be compiled and run.void
validateImports(ICodeSnippetRequestor requestor)
Validates this evaluation context's import declarations.
-
Field Details
-
context
-
project
-
-
Constructor Details
-
EvaluationContextWrapper
Creates a new wrapper around the given infrastructure evaluation context and project.
-
-
Method Details
-
allVariables
Description copied from interface:IEvaluationContext
Returns the global variables declared in this evaluation context. The variables are maintained in the order they are created in.- Specified by:
allVariables
in interfaceIEvaluationContext
- Returns:
- the list of global variables
- See Also:
IEvaluationContext.allVariables()
-
checkBuilderState
protected void checkBuilderState()Checks to ensure that there is a previously built state. -
codeComplete
public void codeComplete(String codeSnippet, int position, ICompletionRequestor requestor) throws JavaModelExceptionDeprecated.Description copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.Note that code completion does not involve evaluation.
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completions- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, ICompletionRequestor)
-
codeComplete
public void codeComplete(String codeSnippet, int position, ICompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelExceptionDeprecated.Description copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor. It considers types in the working copies with the given owner first. In other words, the owner's working copies will take precedence over their original compilation units in the workspace.Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
Note that code completion does not involve evaluation.
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completionsowner
- the owner of working copies that take precedence over their original compilation units- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, ICompletionRequestor, WorkingCopyOwner)
-
codeComplete
public void codeComplete(String codeSnippet, int position, CompletionRequestor requestor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.Note that code completion does not involve evaluation.
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completions- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, CompletionRequestor)
-
codeComplete
public void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.Note that code completion does not involve evaluation.
If
IProgressMonitor
is notnull
then some proposals which can be very long to compute are proposed. To avoid that the code assist operation take too much time aIProgressMonitor
which automatically cancel the code assist operation when a specified amount of time is reached could be used.new IProgressMonitor() { private final static int TIMEOUT = 500; //ms private long endTime; public void beginTask(String name, int totalWork) { fEndTime= System.currentTimeMillis() + TIMEOUT; } public boolean isCanceled() { return endTime <= System.currentTimeMillis(); } ... };
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completionsmonitor
- the progress monitor used to report progress- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, CompletionRequestor, IProgressMonitor)
-
codeComplete
public void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor. It considers types in the working copies with the given owner first. In other words, the owner's working copies will take precedence over their original compilation units in the workspace.Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
Note that code completion does not involve evaluation.
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completionsowner
- the owner of working copies that take precedence over their original compilation units- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, CompletionRequestor, WorkingCopyOwner)
-
codeComplete
public void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor. It considers types in the working copies with the given owner first. In other words, the owner's working copies will take precedence over their original compilation units in the workspace.Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
Note that code completion does not involve evaluation.
If
IProgressMonitor
is notnull
then some proposals which can be very long to compute are proposed. To avoid that the code assist operation take too much time aIProgressMonitor
which automatically cancel the code assist operation when a specified amount of time is reached could be used.new IProgressMonitor() { private final static int TIMEOUT = 500; //ms private long endTime; public void beginTask(String name, int totalWork) { fEndTime= System.currentTimeMillis() + TIMEOUT; } public boolean isCanceled() { return endTime <= System.currentTimeMillis(); } ... };
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completionsowner
- the owner of working copies that take precedence over their original compilation unitsmonitor
- the progress monitor used to report progress- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, CompletionRequestor, WorkingCopyOwner, IProgressMonitor)
-
codeSelect
public IJavaElement[] codeSelect(String codeSnippet, int offset, int length) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Resolves and returns a collection of Java elements corresponding to the source code at the given positions in the given code snippet.Note that code select does not involve evaluation, and problems are never reported.
- Specified by:
codeSelect
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to resolve inoffset
- the position in the code snippet of the first character of the code to resolvelength
- the length of the selected code to resolve- Returns:
- the (possibly empty) list of selection Java elements
- Throws:
JavaModelException
- if code resolve could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeSelect(String, int, int)
-
codeSelect
public IJavaElement[] codeSelect(String codeSnippet, int offset, int length, WorkingCopyOwner owner) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Resolves and returns a collection of Java elements corresponding to the source code at the given positions in the given code snippet. It considers types in the working copies with the given owner first. In other words, the owner's working copies will take precedence over their original compilation units in the workspace.Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
Note that code select does not involve evaluation, and problems are never reported.
- Specified by:
codeSelect
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to resolve inoffset
- the position in the code snippet of the first character of the code to resolvelength
- the length of the selected code to resolveowner
- the owner of working copies that take precedence over their original compilation units- Returns:
- the (possibly empty) list of selection Java elements
- Throws:
JavaModelException
- if code resolve could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeSelect(String, int, int, WorkingCopyOwner)
-
deleteVariable
Description copied from interface:IEvaluationContext
Deletes the given variable from this evaluation context. Does nothing if the given variable has already been deleted.- Specified by:
deleteVariable
in interfaceIEvaluationContext
- Parameters:
variable
- the global variable- See Also:
IEvaluationContext.deleteVariable(IGlobalVariable)
-
evaluateCodeSnippet
public void evaluateCodeSnippet(String codeSnippet, String[] localVariableTypeNames, String[] localVariableNames, int[] localVariableModifiers, IType declaringType, boolean isStatic, boolean isConstructorCall, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Evaluates the given code snippet in the context of a suspended thread. The code snippet is compiled along with this context's package declaration, imports, and global variables. The given requestor'sacceptProblem
method is called for each compilation problem that is detected. Then the resulting class files are handed to the given requestor'sacceptClassFiles
method to deploy and run.The requestor is expected to:
- send the class files to the target VM,
- load them (starting with the code snippet class),
- create a new instance of the code snippet class,
- run the method
run()
of the code snippet, - retrieve the values of the local variables,
- retrieve the returned value of the code snippet
This method is long-running; progress and cancellation are provided by the given progress monitor.
- Specified by:
evaluateCodeSnippet
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippetlocalVariableTypeNames
- the dot-separated fully qualified names of the types of the local variables.localVariableNames
- the names of the local variables as they are declared in the user's code.localVariableModifiers
- the modifiers of the local variables (default modifier or final modifier).declaringType
- the type in which the code snippet is evaluated.isStatic
- whether the code snippet is evaluated in a static member of the declaring type.isConstructorCall
- whether the code snippet is evaluated in a constructor of the declaring type.requestor
- the code snippet requestorprogressMonitor
- a progress monitor- Throws:
JavaModelException
- if a runtime problem occurred or if this context's project has no build state- See Also:
IEvaluationContext.evaluateCodeSnippet(String, String[], String[], int[], IType, boolean, boolean, ICodeSnippetRequestor, IProgressMonitor)
-
evaluateCodeSnippet
public void evaluateCodeSnippet(String codeSnippet, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Evaluates the given code snippet. The code snippet is compiled along with this context's package declaration, imports, and global variables. The given requestor'sacceptProblem
method is called for each compilation problem that is detected. Then the resulting class files are handed to the given requestor'sacceptClassFiles
method to deploy and run. The requestor is also responsible for getting the result back.This method is long-running; progress and cancellation are provided by the given progress monitor.
- Specified by:
evaluateCodeSnippet
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippetrequestor
- the code snippet requestorprogressMonitor
- a progress monitor- Throws:
JavaModelException
- if a runtime problem occurred or if this context's project has no build state- See Also:
IEvaluationContext.evaluateCodeSnippet(String, ICodeSnippetRequestor, IProgressMonitor)
-
evaluateVariable
public void evaluateVariable(IGlobalVariable variable, ICodeSnippetRequestor requestor, org.eclipse.core.runtime.IProgressMonitor progressMonitor) throws JavaModelExceptionDescription copied from interface:IEvaluationContext
Evaluates the given global variable. During this operation, this context's package declaration, imports, and all its declared variables are verified. The given requestor'sacceptProblem
method will be called for each problem that is detected.This method is long-running; progress and cancellation are provided by the given progress monitor.
- Specified by:
evaluateVariable
in interfaceIEvaluationContext
- Parameters:
variable
- the global variablerequestor
- the code snippet requestorprogressMonitor
- a progress monitor- Throws:
JavaModelException
- if a runtime problem occurred or if this context's project has no build state- See Also:
IEvaluationContext.evaluateVariable(IGlobalVariable, ICodeSnippetRequestor, IProgressMonitor)
-
getBuildNameEnvironment
Returns a name environment for the last built state. -
getVarClassName
public char[] getVarClassName() -
getImports
Description copied from interface:IEvaluationContext
Returns the import declarations for this evaluation context. Returns and empty list if there are no imports (the default if the imports have never been set). The syntax for the import corresponds to a fully qualified type name, or to an on-demand package name as defined by ImportDeclaration (JLS2 7.5). For example,"java.util.Hashtable"
or"java.util.*"
.- Specified by:
getImports
in interfaceIEvaluationContext
- Returns:
- the list of import names
- See Also:
IEvaluationContext.getImports()
-
getInfrastructureEvaluationContext
Returns the infrastructure evaluation context. -
getInfrastructureEvaluationRequestor
Returns a new infrastructure evaluation requestor instance. -
getPackageName
Description copied from interface:IEvaluationContext
Returns the name of the package in which code snippets are to be compiled and run. Returns an empty string for the default package (the default if the package name has never been set). For example,"com.example.myapp"
.- Specified by:
getPackageName
in interfaceIEvaluationContext
- Returns:
- the dot-separated package name, or the empty string indicating the default package
- See Also:
IEvaluationContext.getPackageName()
-
getProblemFactory
Returns the problem factory to be used during evaluation. -
getProject
Description copied from interface:IEvaluationContext
Returns the Java project this evaluation context was created for.- Specified by:
getProject
in interfaceIEvaluationContext
- Returns:
- the Java project
- See Also:
IEvaluationContext.getProject()
-
handleInstallException
Handles an install exception by throwing a Java Model exception.- Throws:
JavaModelException
-
newVariable
Description copied from interface:IEvaluationContext
Creates a new global variable with the given name, type, and initializer.The
typeName
andinitializer
are interpreted in the context of this context's package and import declarations.The syntax for a type name corresponds to Type in Field Declaration (JLS2 8.3).
- Specified by:
newVariable
in interfaceIEvaluationContext
- Parameters:
typeName
- the type namename
- the name of the global variableinitializer
- the initializer expression, ornull
if the variable is not initialized- Returns:
- a new global variable with the given name, type, and initializer
- See Also:
IEvaluationContext.newVariable(String, String, String)
-
setImports
Description copied from interface:IEvaluationContext
Sets the import declarations for this evaluation context. An empty list indicates there are no imports. The syntax for the import corresponds to a fully qualified type name, or to an on-demand package name as defined by ImportDeclaration (JLS2 7.5). For example,"java.util.Hashtable"
or"java.util.*"
.- Specified by:
setImports
in interfaceIEvaluationContext
- Parameters:
imports
- the list of import names- See Also:
IEvaluationContext.setImports(String[])
-
setPackageName
Description copied from interface:IEvaluationContext
Sets the dot-separated name of the package in which code snippets are to be compiled and run. For example,"com.example.myapp"
.- Specified by:
setPackageName
in interfaceIEvaluationContext
- Parameters:
packageName
- the dot-separated package name, or the empty string indicating the default package- See Also:
IEvaluationContext.setPackageName(String)
-
validateImports
Description copied from interface:IEvaluationContext
Validates this evaluation context's import declarations. The given requestor'sacceptProblem
method is called for each problem that is detected.- Specified by:
validateImports
in interfaceIEvaluationContext
- Parameters:
requestor
- the code snippet requestor- See Also:
IEvaluationContext.validateImports(ICodeSnippetRequestor)
-
codeComplete
public void codeComplete(String codeSnippet, int position, ICodeCompletionRequestor requestor) throws JavaModelExceptionDeprecated.- use codeComplete(String, int, ICompletionRequestor) insteadDescription copied from interface:IEvaluationContext
Performs a code completion at the given position in the given code snippet, reporting results to the given completion requestor.Note that code completion does not involve evaluation.
- Specified by:
codeComplete
in interfaceIEvaluationContext
- Parameters:
codeSnippet
- the code snippet to complete inposition
- the character position in the code snippet to complete at, or -1 indicating the beginning of the snippetrequestor
- the code completion requestor capable of accepting all possible types of completions- Throws:
JavaModelException
- if code completion could not be performed. Reasons include:- The position specified is less than -1 or is greater than the snippet's length (INDEX_OUT_OF_BOUNDS)
- See Also:
IEvaluationContext.codeComplete(String, int, ICodeCompletionRequestor)
-