public interface IEvaluationContext
A code snippet is pretty much any valid piece of Java code that could be pasted into the body of a method and compiled. However, there are two areas where the rules are slightly more liberal.
First, a code snippet can return heterogeneous types. Inside the same code
snippet an int
could be returned on one line, and a
String
on the next, etc. For example, the following would be
considered a valid code snippet:
char c = '3';
switch (c) {
case '1': return 1;
case '2': return '2';
case '3': return "3";
default: return null;
}
Second, if the last statement is only an expression, the return
keyword is implied. For example, the following returns false
:
int i = 1;
i == 2
Global variables are an additional feature of evaluation contexts. Within an evaluation context, global variables maintain their value across evaluations. These variables are particularly useful for storing the result of an evaluation for use in subsequent evaluations.
The evaluation context remembers the name of the package in which code snippets are run. The user can set this to any package, thereby gaining access to types that are normally only visible within that package.
Finally, the evaluation context remembers a list of import declarations. The user can import any packages and types so that the code snippets may refer to types by their shorter simple names.
Example of use:
IJavaProject project = getJavaProject();
IEvaluationContext context = project.newEvaluationContext();
String codeSnippet = "int i= 0; i++";
ICodeSnippetRequestor requestor = ...;
context.evaluateCodeSnippet(codeSnippet, requestor, progressMonitor);
IJavaProject.newEvaluationContext
can be used to obtain an
instance.
IJavaProject.newEvaluationContext()
Modifier and Type | Method and Description |
---|---|
IGlobalVariable[] |
allVariables()
Returns the global variables declared in this evaluation context.
|
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,
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,
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,
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) instead
|
void |
codeComplete(String codeSnippet,
int position,
ICompletionRequestor requestor)
Deprecated.
Use
codeComplete(String,int,CompletionRequestor) instead. |
void |
codeComplete(String codeSnippet,
int position,
ICompletionRequestor requestor,
WorkingCopyOwner owner)
Deprecated.
|
IJavaElement[] |
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.
|
IJavaElement[] |
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,
ICodeSnippetRequestor requestor,
IProgressMonitor progressMonitor)
Evaluates the given code snippet.
|
void |
evaluateCodeSnippet(String codeSnippet,
String[] localVariableTypeNames,
String[] localVariableNames,
int[] localVariableModifiers,
IType declaringType,
boolean isStatic,
boolean isConstructorCall,
ICodeSnippetRequestor requestor,
IProgressMonitor progressMonitor)
Evaluates the given code snippet in the context of a suspended thread.
|
void |
evaluateVariable(IGlobalVariable variable,
ICodeSnippetRequestor requestor,
IProgressMonitor progressMonitor)
Evaluates the given global variable.
|
String[] |
getImports()
Returns the import declarations for this evaluation context.
|
String |
getPackageName()
Returns the name of the package in which code snippets are to be compiled and
run.
|
IJavaProject |
getProject()
Returns the Java project this evaluation context was created for.
|
IGlobalVariable |
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.
|
IGlobalVariable[] allVariables()
void codeComplete(String codeSnippet, int position, ICompletionRequestor requestor) throws JavaModelException
codeComplete(String,int,CompletionRequestor)
instead.Note that code completion does not involve evaluation.
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 completionsJavaModelException
- if code completion could not be performed. Reasons include:
void codeComplete(String codeSnippet, int position, ICompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelException
codeComplete(String,int,CompletionRequestor,WorkingCopyOwner)
instead.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.
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 unitsJavaModelException
- if code completion could not be performed. Reasons include:
void codeComplete(String codeSnippet, int position, CompletionRequestor requestor) throws JavaModelException
Note that code completion does not involve evaluation.
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 completionsJavaModelException
- if code completion could not be performed. Reasons include:
void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, IProgressMonitor monitor) throws JavaModelException
Note that code completion does not involve evaluation.
If IProgressMonitor
is not null
then some proposals which
can be very long to compute are proposed. To avoid that the code assist operation
take too much time a IProgressMonitor
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(); } ... };
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 progressJavaModelException
- if code completion could not be performed. Reasons include:
void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelException
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.
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 unitsJavaModelException
- if code completion could not be performed. Reasons include:
void codeComplete(String codeSnippet, int position, CompletionRequestor requestor, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaModelException
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 not null
then some proposals which
can be very long to compute are proposed. To avoid that the code assist operation
take too much time a IProgressMonitor
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(); } ... };
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 progressJavaModelException
- if code completion could not be performed. Reasons include:
IJavaElement[] codeSelect(String codeSnippet, int offset, int length) throws JavaModelException
Note that code select does not involve evaluation, and problems are never reported.
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 resolveJavaModelException
- if code resolve could not be performed.
Reasons include:
IJavaElement[] codeSelect(String codeSnippet, int offset, int length, WorkingCopyOwner owner) throws JavaModelException
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.
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 unitsJavaModelException
- if code resolve could not be performed.
Reasons include:
void deleteVariable(IGlobalVariable variable)
variable
- the global variablevoid evaluateCodeSnippet(String codeSnippet, String[] localVariableTypeNames, String[] localVariableNames, int[] localVariableModifiers, IType declaringType, boolean isStatic, boolean isConstructorCall, ICodeSnippetRequestor requestor, IProgressMonitor progressMonitor) throws JavaModelException
acceptProblem
method is called for each compilation problem that
is detected. Then the resulting class files are handed to the given
requestor's acceptClassFiles
method to deploy and run.
The requestor is expected to:
run()
of the code snippet,
This method is long-running; progress and cancellation are provided by the given progress monitor.
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 monitorJavaModelException
- if a runtime problem occurred or if this
context's project has no build statevoid evaluateCodeSnippet(String codeSnippet, ICodeSnippetRequestor requestor, IProgressMonitor progressMonitor) throws JavaModelException
acceptProblem
method
is called for each compilation problem that is detected. Then the resulting
class files are handed to the given requestor's acceptClassFiles
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.
codeSnippet
- the code snippetrequestor
- the code snippet requestorprogressMonitor
- a progress monitorJavaModelException
- if a runtime problem occurred or if this
context's project has no build statevoid evaluateVariable(IGlobalVariable variable, ICodeSnippetRequestor requestor, IProgressMonitor progressMonitor) throws JavaModelException
acceptProblem
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.
variable
- the global variablerequestor
- the code snippet requestorprogressMonitor
- a progress monitorJavaModelException
- if a runtime problem occurred or if this
context's project has no build stateString[] getImports()
"java.util.Hashtable"
or "java.util.*"
.String getPackageName()
"com.example.myapp"
.IJavaProject getProject()
IGlobalVariable newVariable(String typeName, String name, String initializer)
The typeName
and initializer
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).
typeName
- the type namename
- the name of the global variableinitializer
- the initializer expression, or null
if the
variable is not initializedvoid setImports(String[] imports)
"java.util.Hashtable"
or "java.util.*"
.imports
- the list of import namesvoid setPackageName(String packageName)
"com.example.myapp"
.packageName
- the dot-separated package name, or the empty string
indicating the default packagevoid validateImports(ICodeSnippetRequestor requestor) throws JavaModelException
acceptProblem
method is called for each problem that is detected.requestor
- the code snippet requestorJavaModelException
- if this context's project has no build statevoid codeComplete(String codeSnippet, int position, ICodeCompletionRequestor requestor) throws JavaModelException
Note that code completion does not involve evaluation.
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 completionsJavaModelException
- if code completion could not be performed. Reasons include:
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.