OLD | NEW |
1 <!DOCTYPE html><html><head> | 1 <!DOCTYPE html><html><head> |
2 <meta charset="UTF-8"> | 2 <meta charset="UTF-8"> |
3 <title>Analysis Server API Specification</title> | 3 <title>Analysis Server API Specification</title> |
4 <style>body { | 4 <style>body { |
5 font-family: sans-serif, serif; | 5 font-family: sans-serif, serif; |
6 padding-left: 5%; | 6 padding-left: 5%; |
7 padding-right: 5%; | 7 padding-right: 5%; |
8 } | 8 } |
9 h1 { | 9 h1 { |
10 text-align: center; | 10 text-align: center; |
(...skipping 3923 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3934 Convert a method into a getter by adding the keyword get and | 3934 Convert a method into a getter by adding the keyword get and |
3935 removing the parameter list. | 3935 removing the parameter list. |
3936 </p> | 3936 </p> |
3937 <p> | 3937 <p> |
3938 It is an error if the range contains anything other than all | 3938 It is an error if the range contains anything other than all |
3939 or part of the name of a single method or if the method has | 3939 or part of the name of a single method or if the method has |
3940 a non-empty parameter list. | 3940 a non-empty parameter list. |
3941 </p> | 3941 </p> |
3942 <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="ref
actoring">EXTRACT_LOCAL_VARIABLE</dt><dd> | 3942 <h4>Feedback</h4><p>none</p><h4>Options</h4><p>none</p></dd><dt class="ref
actoring">EXTRACT_LOCAL_VARIABLE</dt><dd> |
3943 <p> | 3943 <p> |
3944 Create a local variable initialized by a specified | 3944 Create a local variable initialized by the expression that covers |
3945 expression. | 3945 the specified selection. |
3946 </p> | 3946 </p> |
3947 <p> | 3947 <p> |
3948 It is an error if the range contains anything other than a | 3948 It is an error if the selection range is not covered by a |
3949 complete expression (no partial expressions are allowed). | 3949 complete expression. |
3950 </p> | 3950 </p> |
3951 | 3951 |
3952 | 3952 |
3953 <h4>Feedback</h4><dl><dt class="field"><b><i>names ( List<String> )<
/i></b></dt><dd> | 3953 <h4>Feedback</h4><dl><dt class="field"><b><i>coveringExpressionOffsets ( L
ist<int> )</i></b></dt><dd> |
| 3954 |
| 3955 <p> |
| 3956 The offsets of the expressions that cover the specified |
| 3957 selection, from the down most to the up most. |
| 3958 </p> |
| 3959 </dd><dt class="field"><b><i>coveringExpressionLengths ( List<int&g
t; )</i></b></dt><dd> |
| 3960 |
| 3961 <p> |
| 3962 The lengths of the expressions that cover the specified |
| 3963 selection, from the down most to the up most. |
| 3964 </p> |
| 3965 </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt>
<dd> |
3954 | 3966 |
3955 <p> | 3967 <p> |
3956 The proposed names for the local variable. | 3968 The proposed names for the local variable. |
3957 </p> | 3969 </p> |
3958 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><
dd> | 3970 </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><
dd> |
3959 | 3971 |
3960 <p> | 3972 <p> |
3961 The offsets of the expressions that would be replaced by | 3973 The offsets of the expressions that would be replaced by |
3962 a reference to the variable. | 3974 a reference to the variable. |
3963 </p> | 3975 </p> |
(...skipping 258 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
4222 produced by the server and the data that is returned with each. | 4234 produced by the server and the data that is returned with each. |
4223 </p> | 4235 </p> |
4224 <p> | 4236 <p> |
4225 TBD | 4237 TBD |
4226 </p> | 4238 </p> |
4227 <h2 class="domain"><a name="index">Index</a></h2> | 4239 <h2 class="domain"><a name="index">Index</a></h2> |
4228 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</a></li></ul></div></div><h4>analysis (<a
href="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><
li><a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</
a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li
><li><a href="#request_analysis.updateContent">updateContent</a></li><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href=
"#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>)</h3><div c
lass="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a><
/li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_A
nalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSe
verity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Anal
ysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></l
i><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type
_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay"
>ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a><
/li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a
href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a h
ref="#type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind<
/a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#
type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextI
d">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionServ
ice</a></li><li><a href="#type_FileKind">FileKind</a></li><li><a href="#type_Fil
ePath">FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li>
<a href="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAn
alysisService">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion
">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegio
nType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li>
<a href="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Imp
lementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">Li
nkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggest
ion</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKin
d</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Navig
ationRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Navig
ationTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a h
ref="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></l
i><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#ty
pe_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><l
i><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Ref
actoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_R
efactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOp
tions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterK
ind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProble
m">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Ref
actoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveC
ontentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li>
<a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sea
rchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><l
i><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_S
erverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChang
e</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_S
ourceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">Type
HierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>
)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METH
OD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO
_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCA
L_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_MET
HOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INL
INE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHO
D</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#r
efactoring_RENAME">RENAME</a></li></ul></div> | 4240 <h3>Domains</h3><h4>server (<a href="#domain_server">↑</a>)</h4><div class="
subindex"><h5>Requests</h5><ul><li><a href="#request_server.getVersion">getVersi
on</a></li><li><a href="#request_server.shutdown">shutdown</a></li><li><a href="
#request_server.setSubscriptions">setSubscriptions</a></li></ul><h5>Notification
s</h5><div class="subindex"><ul><li><a href="#notification_server.connected">con
nected</a></li><li><a href="#notification_server.error">error</a></li><li><a hre
f="#notification_server.status">status</a></li></ul></div></div><h4>analysis (<a
href="#domain_analysis">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><
li><a href="#request_analysis.getErrors">getErrors</a></li><li><a href="#request
_analysis.getHover">getHover</a></li><li><a href="#request_analysis.getLibraryDe
pendencies">getLibraryDependencies</a></li><li><a href="#request_analysis.getNav
igation">getNavigation</a></li><li><a href="#request_analysis.reanalyze">reanaly
ze</a></li><li><a href="#request_analysis.setAnalysisRoots">setAnalysisRoots</a>
</li><li><a href="#request_analysis.setGeneralSubscriptions">setGeneralSubscript
ions</a></li><li><a href="#request_analysis.setPriorityFiles">setPriorityFiles</
a></li><li><a href="#request_analysis.setSubscriptions">setSubscriptions</a></li
><li><a href="#request_analysis.updateContent">updateContent</a></li><li><a href
="#request_analysis.updateOptions">updateOptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_analysis.analyzedFiles"
>analyzedFiles</a></li><li><a href="#notification_analysis.errors">errors</a></l
i><li><a href="#notification_analysis.flushResults">flushResults</a></li><li><a
href="#notification_analysis.folding">folding</a></li><li><a href="#notification
_analysis.highlights">highlights</a></li><li><a href="#notification_analysis.imp
lemented">implemented</a></li><li><a href="#notification_analysis.invalidate">in
validate</a></li><li><a href="#notification_analysis.navigation">navigation</a><
/li><li><a href="#notification_analysis.occurrences">occurrences</a></li><li><a
href="#notification_analysis.outline">outline</a></li><li><a href="#notification
_analysis.overrides">overrides</a></li></ul></div></div><h4>completion (<a href=
"#domain_completion">↑</a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><
a href="#request_completion.getSuggestions">getSuggestions</a></li></ul><h5>Noti
fications</h5><div class="subindex"><ul><li><a href="#notification_completion.re
sults">results</a></li></ul></div></div><h4>search (<a href="#domain_search">↑</
a>)</h4><div class="subindex"><h5>Requests</h5><ul><li><a href="#request_search.
findElementReferences">findElementReferences</a></li><li><a href="#request_searc
h.findMemberDeclarations">findMemberDeclarations</a></li><li><a href="#request_s
earch.findMemberReferences">findMemberReferences</a></li><li><a href="#request_s
earch.findTopLevelDeclarations">findTopLevelDeclarations</a></li><li><a href="#r
equest_search.getTypeHierarchy">getTypeHierarchy</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_search.results">results
</a></li></ul></div></div><h4>edit (<a href="#domain_edit">↑</a>)</h4><div class
="subindex"><h5>Requests</h5><ul><li><a href="#request_edit.format">format</a></
li><li><a href="#request_edit.getAssists">getAssists</a></li><li><a href="#reque
st_edit.getAvailableRefactorings">getAvailableRefactorings</a></li><li><a href="
#request_edit.getFixes">getFixes</a></li><li><a href="#request_edit.getRefactori
ng">getRefactoring</a></li><li><a href="#request_edit.sortMembers">sortMembers</
a></li><li><a href="#request_edit.organizeDirectives">organizeDirectives</a></li
></ul></div><h4>execution (<a href="#domain_execution">↑</a>)</h4><div class="su
bindex"><h5>Requests</h5><ul><li><a href="#request_execution.createContext">crea
teContext</a></li><li><a href="#request_execution.deleteContext">deleteContext</
a></li><li><a href="#request_execution.mapUri">mapUri</a></li><li><a href="#requ
est_execution.setSubscriptions">setSubscriptions</a></li></ul><h5>Notifications<
/h5><div class="subindex"><ul><li><a href="#notification_execution.launchData">l
aunchData</a></li></ul></div></div><h3>Types (<a href="#types">↑</a>)</h3><div c
lass="subindex"><ul><li><a href="#type_AddContentOverlay">AddContentOverlay</a><
/li><li><a href="#type_AnalysisError">AnalysisError</a></li><li><a href="#type_A
nalysisErrorFixes">AnalysisErrorFixes</a></li><li><a href="#type_AnalysisErrorSe
verity">AnalysisErrorSeverity</a></li><li><a href="#type_AnalysisErrorType">Anal
ysisErrorType</a></li><li><a href="#type_AnalysisOptions">AnalysisOptions</a></l
i><li><a href="#type_AnalysisService">AnalysisService</a></li><li><a href="#type
_AnalysisStatus">AnalysisStatus</a></li><li><a href="#type_ChangeContentOverlay"
>ChangeContentOverlay</a></li><li><a href="#type_CompletionId">CompletionId</a><
/li><li><a href="#type_CompletionSuggestion">CompletionSuggestion</a></li><li><a
href="#type_CompletionSuggestionKind">CompletionSuggestionKind</a></li><li><a h
ref="#type_Element">Element</a></li><li><a href="#type_ElementKind">ElementKind<
/a></li><li><a href="#type_ExecutableFile">ExecutableFile</a></li><li><a href="#
type_ExecutableKind">ExecutableKind</a></li><li><a href="#type_ExecutionContextI
d">ExecutionContextId</a></li><li><a href="#type_ExecutionService">ExecutionServ
ice</a></li><li><a href="#type_FileKind">FileKind</a></li><li><a href="#type_Fil
ePath">FilePath</a></li><li><a href="#type_FoldingKind">FoldingKind</a></li><li>
<a href="#type_FoldingRegion">FoldingRegion</a></li><li><a href="#type_GeneralAn
alysisService">GeneralAnalysisService</a></li><li><a href="#type_HighlightRegion
">HighlightRegion</a></li><li><a href="#type_HighlightRegionType">HighlightRegio
nType</a></li><li><a href="#type_HoverInformation">HoverInformation</a></li><li>
<a href="#type_ImplementedClass">ImplementedClass</a></li><li><a href="#type_Imp
lementedMember">ImplementedMember</a></li><li><a href="#type_LinkedEditGroup">Li
nkedEditGroup</a></li><li><a href="#type_LinkedEditSuggestion">LinkedEditSuggest
ion</a></li><li><a href="#type_LinkedEditSuggestionKind">LinkedEditSuggestionKin
d</a></li><li><a href="#type_Location">Location</a></li><li><a href="#type_Navig
ationRegion">NavigationRegion</a></li><li><a href="#type_NavigationTarget">Navig
ationTarget</a></li><li><a href="#type_Occurrences">Occurrences</a></li><li><a h
ref="#type_Outline">Outline</a></li><li><a href="#type_Override">Override</a></l
i><li><a href="#type_OverriddenMember">OverriddenMember</a></li><li><a href="#ty
pe_Position">Position</a></li><li><a href="#type_PubStatus">PubStatus</a></li><l
i><a href="#type_RefactoringKind">RefactoringKind</a></li><li><a href="#type_Ref
actoringMethodParameter">RefactoringMethodParameter</a></li><li><a href="#type_R
efactoringFeedback">RefactoringFeedback</a></li><li><a href="#type_RefactoringOp
tions">RefactoringOptions</a></li><li><a href="#type_RefactoringMethodParameterK
ind">RefactoringMethodParameterKind</a></li><li><a href="#type_RefactoringProble
m">RefactoringProblem</a></li><li><a href="#type_RefactoringProblemSeverity">Ref
actoringProblemSeverity</a></li><li><a href="#type_RemoveContentOverlay">RemoveC
ontentOverlay</a></li><li><a href="#type_RequestError">RequestError</a></li><li>
<a href="#type_RequestErrorCode">RequestErrorCode</a></li><li><a href="#type_Sea
rchId">SearchId</a></li><li><a href="#type_SearchResult">SearchResult</a></li><l
i><a href="#type_SearchResultKind">SearchResultKind</a></li><li><a href="#type_S
erverService">ServerService</a></li><li><a href="#type_SourceChange">SourceChang
e</a></li><li><a href="#type_SourceEdit">SourceEdit</a></li><li><a href="#type_S
ourceFileEdit">SourceFileEdit</a></li><li><a href="#type_TypeHierarchyItem">Type
HierarchyItem</a></li></ul></div><h3>Refactorings (<a href="#refactorings">↑</a>
)</h3><div class="subindex"><ul><li><a href="#refactoring_CONVERT_GETTER_TO_METH
OD">CONVERT_GETTER_TO_METHOD</a></li><li><a href="#refactoring_CONVERT_METHOD_TO
_GETTER">CONVERT_METHOD_TO_GETTER</a></li><li><a href="#refactoring_EXTRACT_LOCA
L_VARIABLE">EXTRACT_LOCAL_VARIABLE</a></li><li><a href="#refactoring_EXTRACT_MET
HOD">EXTRACT_METHOD</a></li><li><a href="#refactoring_INLINE_LOCAL_VARIABLE">INL
INE_LOCAL_VARIABLE</a></li><li><a href="#refactoring_INLINE_METHOD">INLINE_METHO
D</a></li><li><a href="#refactoring_MOVE_FILE">MOVE_FILE</a></li><li><a href="#r
efactoring_RENAME">RENAME</a></li></ul></div> |
4229 | 4241 |
4230 | 4242 |
4231 </body></html> | 4243 </body></html> |
OLD | NEW |