Interface ICodeAssist
-
- All Known Subinterfaces:
IClassFile,ICompilationUnit,IModularClassFile,IOrdinaryClassFile,ITypeRoot
public interface ICodeAssistCommon protocol for Java elements that support source code assist and code resolve.- Restriction:
- This interface is not intended to be implemented by clients.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidcodeComplete(int offset, CompletionRequestor requestor)Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor.voidcodeComplete(int offset, CompletionRequestor requestor, IProgressMonitor monitor)Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor.voidcodeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner owner)Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor.voidcodeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner owner, IProgressMonitor monitor)Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor.voidcodeComplete(int offset, ICodeCompletionRequestor requestor)Deprecated.UsecodeComplete(int, ICompletionRequestor)instead.voidcodeComplete(int offset, ICompletionRequestor requestor)Deprecated.UsecodeComplete(int, CompletionRequestor)instead.voidcodeComplete(int offset, ICompletionRequestor requestor, WorkingCopyOwner owner)Deprecated.IJavaElement[]codeSelect(int offset, int length)Returns the Java elements corresponding to the given selected text in this compilation unit.IJavaElement[]codeSelect(int offset, int length, WorkingCopyOwner owner)Returns the Java elements corresponding to the given selected text in this compilation unit.
-
-
-
Method Detail
-
codeComplete
void codeComplete(int offset, ICodeCompletionRequestor requestor) throws JavaModelExceptionDeprecated.UsecodeComplete(int, ICompletionRequestor)instead.Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit.- Parameters:
offset- the given offset positionrequestor- the given completion requestor- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull
-
codeComplete
void codeComplete(int offset, ICompletionRequestor requestor) throws JavaModelExceptionDeprecated.UsecodeComplete(int, CompletionRequestor)instead.Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit.- Parameters:
offset- the given offset positionrequestor- the given completion requestor- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 2.0
-
codeComplete
void codeComplete(int offset, CompletionRequestor requestor) throws JavaModelExceptionPerforms code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit.- Parameters:
offset- the given offset positionrequestor- the given completion requestor- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 3.0
-
codeComplete
void codeComplete(int offset, CompletionRequestor requestor, IProgressMonitor monitor) throws JavaModelExceptionPerforms code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit.If
IProgressMonitoris notnullthen some proposals which can be very long to compute are proposed. To avoid that the code assist operation take too much time aIProgressMonitorwhich 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(); } ... };- Parameters:
offset- the given offset positionrequestor- the given completion requestormonitor- the progress monitor used to report progress- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 3.5
-
codeComplete
void codeComplete(int offset, ICompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelExceptionDeprecated.Performs code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit. 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.
- Parameters:
offset- the given offset positionrequestor- the given completion requestorowner- the owner of working copies that take precedence over their original compilation units- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 3.0
-
codeComplete
void codeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner owner) throws JavaModelExceptionPerforms code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit. 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.
- Parameters:
offset- the given offset positionrequestor- the given completion requestorowner- the owner of working copies that take precedence over their original compilation units- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 3.0
-
codeComplete
void codeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner owner, IProgressMonitor monitor) throws JavaModelExceptionPerforms code completion at the given offset position in this compilation unit, reporting results to the given completion requestor. Theoffsetis the 0-based index of the character, after which code assist is desired. Anoffsetof -1 indicates to code assist at the beginning of this compilation unit. 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.
If
IProgressMonitoris notnullthen some proposals which can be very long to compute are proposed. To avoid that the code assist operation take too much time aIProgressMonitorwhich 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(); } ... };- Parameters:
offset- the given offset positionrequestor- the given completion requestorowner- the owner of working copies that take precedence over their original compilation unitsmonitor- the progress monitor used to report progress- Throws:
JavaModelException- if code assist could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The position specified is < -1 or is greater than this compilation unit's source length (INDEX_OUT_OF_BOUNDS)
IllegalArgumentException- ifrequestorisnull- Since:
- 3.5
-
codeSelect
IJavaElement[] codeSelect(int offset, int length) throws JavaModelException
Returns the Java elements corresponding to the given selected text in this compilation unit. Theoffsetis the 0-based index of the first selected character. Thelengthis the number of selected characters.Note that if the
lengthis 0 and theoffsetis inside an identifier or the index just after an identifier then this identifier is considered as the selection.- Parameters:
offset- the given offset positionlength- the number of selected characters- Returns:
- the Java elements corresponding to the given selected text
- Throws:
JavaModelException- if code resolve could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The range specified is not within this element's source range (INDEX_OUT_OF_BOUNDS)
-
codeSelect
IJavaElement[] codeSelect(int offset, int length, WorkingCopyOwner owner) throws JavaModelException
Returns the Java elements corresponding to the given selected text in this compilation unit. Theoffsetis the 0-based index of the first selected character. Thelengthis the number of selected characters. 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 the
lengthis 0 and theoffsetis inside an identifier or the index just after an identifier then this identifier is considered as the selection.Note that if a working copy is empty, it will be as if the original compilation unit had been deleted.
- Parameters:
offset- the given offset positionlength- the number of selected charactersowner- the owner of working copies that take precedence over their original compilation units- Returns:
- the Java elements corresponding to the given selected text
- Throws:
JavaModelException- if code resolve could not be performed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- The range specified is not within this element's source range (INDEX_OUT_OF_BOUNDS)
- Since:
- 3.0
-
-