| Index: pkg/analysis_server/doc/api.html
|
| diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html
|
| index 67c31daf6dfe65cf4ec6b3e214e01d1bd0f06d22..036cb3d94457a0959834d56af8bc49eb5968ea5a 100644
|
| --- a/pkg/analysis_server/doc/api.html
|
| +++ b/pkg/analysis_server/doc/api.html
|
| @@ -73,9 +73,16 @@ dt.typeDefinition {
|
| To ease interoperability with Lisp-based clients (which may not
|
| be able to easily distinguish between empty lists, empty maps,
|
| and null), client-to-server communication is allowed to replace
|
| - any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. The
|
| - server will always properly represent empty lists as
|
| - “<tt>[]</tt>” and empty maps as “<tt>{}</tt>”.
|
| + any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null.
|
| + </p>
|
| + <p>
|
| + In addition, to conserve bytes, all object fields of type "List"
|
| + are optional; omitting such a field carries the same meaning as
|
| + sending an empty list.
|
| + </p>
|
| + <p>
|
| + Server-to-client communication will always omit empty lists, and
|
| + will always represent empty maps as <tt>{}</tt>.
|
| </p>
|
| <h3>Communication Structure</h3>
|
| <p>
|
| @@ -218,7 +225,7 @@ dt.typeDefinition {
|
| "id": String
|
| "method": "server.setSubscriptions"
|
| "params": {
|
| - "<b>subscriptions</b>": List<<a href="#type_ServerService">ServerService</a>>
|
| + "<b>subscriptions</b>": <span style="color:#999999">optional</span> List<<a href="#type_ServerService">ServerService</a>>
|
| }
|
| }</pre><br><pre>response: {
|
| "id": String
|
| @@ -234,7 +241,7 @@ dt.typeDefinition {
|
| subscriptions will remain unchanged.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( <span style="color:#999999">optional</span> List<<a href="#type_ServerService">ServerService</a>> )</i></b></dt><dd>
|
|
|
| <p>A list of the services being subscribed to.</p>
|
| </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification">server.connected</dt><dd><div class="box"><pre>notification: {
|
| @@ -347,7 +354,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>>
|
| + "<b>errors</b>": <span style="color:#999999">optional</span> List<<a href="#type_AnalysisError">AnalysisError</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -375,7 +382,7 @@ dt.typeDefinition {
|
| <p>
|
| The file for which errors are being requested.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>errors ( <span style="color:#999999">optional</span> List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The errors associated with the file.
|
| @@ -391,7 +398,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>hovers</b>": List<<a href="#type_HoverInformation">HoverInformation</a>>
|
| + "<b>hovers</b>": <span style="color:#999999">optional</span> List<<a href="#type_HoverInformation">HoverInformation</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -414,11 +421,11 @@ dt.typeDefinition {
|
| The offset for which hover information is being
|
| requested.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List<<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( <span style="color:#999999">optional</span> List<<a href="#type_HoverInformation">HoverInformation</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The hover information associated with the
|
| - location. The list will be empty if no information
|
| + location. The list will be omitted if no information
|
| could be determined for the location. The list can
|
| contain multiple items if the file is being analyzed
|
| in multiple contexts in conflicting ways (such as a
|
| @@ -441,8 +448,8 @@ dt.typeDefinition {
|
| "id": String
|
| "method": "analysis.setAnalysisRoots"
|
| "params": {
|
| - "<b>included</b>": List<<a href="#type_FilePath">FilePath</a>>
|
| - "<b>excluded</b>": List<<a href="#type_FilePath">FilePath</a>>
|
| + "<b>included</b>": <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>
|
| + "<b>excluded</b>": <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>
|
| }
|
| }</pre><br><pre>response: {
|
| "id": String
|
| @@ -478,13 +485,13 @@ dt.typeDefinition {
|
| be used to resolve package: URI’s within the file.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>included ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>included ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the files and directories that should be
|
| analyzed.
|
| </p>
|
| - </dd><dt class="field"><b><i>excluded ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>excluded ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the files and directories within the
|
| @@ -494,7 +501,7 @@ dt.typeDefinition {
|
| "id": String
|
| "method": "analysis.setPriorityFiles"
|
| "params": {
|
| - "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>>
|
| + "<b>files</b>": <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>
|
| }
|
| }</pre><br><pre>response: {
|
| "id": String
|
| @@ -526,7 +533,7 @@ dt.typeDefinition {
|
| actual priority files.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>files ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The files that are to be a priority for analysis.
|
| @@ -635,7 +642,7 @@ dt.typeDefinition {
|
| "event": "analysis.errors"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>errors</b>": List<<a href="#type_AnalysisError">AnalysisError</a>>
|
| + "<b>errors</b>": <span style="color:#999999">optional</span> List<<a href="#type_AnalysisError">AnalysisError</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -653,7 +660,7 @@ dt.typeDefinition {
|
| <p>
|
| The file containing the errors.
|
| </p>
|
| - </dd><dt class="field"><b><i>errors ( List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>errors ( <span style="color:#999999">optional</span> List<<a href="#type_AnalysisError">AnalysisError</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The errors contained in the file.
|
| @@ -661,7 +668,7 @@ dt.typeDefinition {
|
| </dd></dl></dd><dt class="notification">analysis.flushResults</dt><dd><div class="box"><pre>notification: {
|
| "event": "analysis.flushResults"
|
| "params": {
|
| - "<b>files</b>": List<<a href="#type_FilePath">FilePath</a>>
|
| + "<b>files</b>": <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -682,7 +689,7 @@ dt.typeDefinition {
|
| notification.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>files ( List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>files ( <span style="color:#999999">optional</span> List<<a href="#type_FilePath">FilePath</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The files that are no longer being analyzed.
|
| @@ -691,7 +698,7 @@ dt.typeDefinition {
|
| "event": "analysis.folding"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>regions</b>": List<<a href="#type_FoldingRegion">FoldingRegion</a>>
|
| + "<b>regions</b>": <span style="color:#999999">optional</span> List<<a href="#type_FoldingRegion">FoldingRegion</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -713,7 +720,7 @@ dt.typeDefinition {
|
| <p>
|
| The file containing the folding regions.
|
| </p>
|
| - </dd><dt class="field"><b><i>regions ( List<<a href="#type_FoldingRegion">FoldingRegion</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>regions ( <span style="color:#999999">optional</span> List<<a href="#type_FoldingRegion">FoldingRegion</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The folding regions contained in the file.
|
| @@ -722,7 +729,7 @@ dt.typeDefinition {
|
| "event": "analysis.highlights"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>regions</b>": List<<a href="#type_HighlightRegion">HighlightRegion</a>>
|
| + "<b>regions</b>": <span style="color:#999999">optional</span> List<<a href="#type_HighlightRegion">HighlightRegion</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -740,7 +747,7 @@ dt.typeDefinition {
|
| <p>
|
| The file containing the highlight regions.
|
| </p>
|
| - </dd><dt class="field"><b><i>regions ( List<<a href="#type_HighlightRegion">HighlightRegion</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>regions ( <span style="color:#999999">optional</span> List<<a href="#type_HighlightRegion">HighlightRegion</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The highlight regions contained in the file. Each
|
| @@ -754,7 +761,7 @@ dt.typeDefinition {
|
| "event": "analysis.navigation"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>regions</b>": List<<a href="#type_NavigationRegion">NavigationRegion</a>>
|
| + "<b>regions</b>": <span style="color:#999999">optional</span> List<<a href="#type_NavigationRegion">NavigationRegion</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -772,7 +779,7 @@ dt.typeDefinition {
|
| <p>
|
| The file containing the navigation regions.
|
| </p>
|
| - </dd><dt class="field"><b><i>regions ( List<<a href="#type_NavigationRegion">NavigationRegion</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>regions ( <span style="color:#999999">optional</span> List<<a href="#type_NavigationRegion">NavigationRegion</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The navigation regions contained in the file. Each
|
| @@ -789,7 +796,7 @@ dt.typeDefinition {
|
| "event": "analysis.occurrences"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>occurrences</b>": List<<a href="#type_Occurrences">Occurrences</a>>
|
| + "<b>occurrences</b>": <span style="color:#999999">optional</span> List<<a href="#type_Occurrences">Occurrences</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -808,7 +815,7 @@ dt.typeDefinition {
|
| <p>
|
| The file in which the references occur.
|
| </p>
|
| - </dd><dt class="field"><b><i>occurrences ( List<<a href="#type_Occurrences">Occurrences</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>occurrences ( <span style="color:#999999">optional</span> List<<a href="#type_Occurrences">Occurrences</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The occurrences of references to elements within the
|
| @@ -845,7 +852,7 @@ dt.typeDefinition {
|
| "event": "analysis.overrides"
|
| "params": {
|
| "<b>file</b>": <a href="#type_FilePath">FilePath</a>
|
| - "<b>overrides</b>": List<<a href="#type_Override">Override</a>>
|
| + "<b>overrides</b>": <span style="color:#999999">optional</span> List<<a href="#type_Override">Override</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -863,7 +870,7 @@ dt.typeDefinition {
|
| <p>
|
| The file with which the overrides are associated.
|
| </p>
|
| - </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Override">Override</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>overrides ( <span style="color:#999999">optional</span> List<<a href="#type_Override">Override</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The overrides associated with the file.
|
| @@ -920,7 +927,7 @@ dt.typeDefinition {
|
| "<b>id</b>": <a href="#type_CompletionId">CompletionId</a>
|
| "<b>replacementOffset</b>": int
|
| "<b>replacementLength</b>": int
|
| - "<b>results</b>": List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>>
|
| + "<b>results</b>": <span style="color:#999999">optional</span> List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>>
|
| "<b>last</b>": bool
|
| }
|
| }</pre></div>
|
| @@ -954,7 +961,7 @@ dt.typeDefinition {
|
| replaced when the suggestion is applied (that is, the
|
| number of characters in the existing identifier).
|
| </p>
|
| - </dd><dt class="field"><b><i>results ( List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>results ( <span style="color:#999999">optional</span> List<<a href="#type_CompletionSuggestion">CompletionSuggestion</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The completion suggestions being reported. The
|
| @@ -1204,7 +1211,7 @@ dt.typeDefinition {
|
| "event": "search.results"
|
| "params": {
|
| "<b>id</b>": <a href="#type_SearchId">SearchId</a>
|
| - "<b>results</b>": List<<a href="#type_SearchResult">SearchResult</a>>
|
| + "<b>results</b>": <span style="color:#999999">optional</span> List<<a href="#type_SearchResult">SearchResult</a>>
|
| "<b>last</b>": bool
|
| }
|
| }</pre></div>
|
| @@ -1221,7 +1228,7 @@ dt.typeDefinition {
|
| <p>
|
| The id associated with the search.
|
| </p>
|
| - </dd><dt class="field"><b><i>results ( List<<a href="#type_SearchResult">SearchResult</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>results ( <span style="color:#999999">optional</span> List<<a href="#type_SearchResult">SearchResult</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The search results being reported.
|
| @@ -1254,7 +1261,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>assists</b>": List<<a href="#type_SourceChange">SourceChange</a>>
|
| + "<b>assists</b>": <span style="color:#999999">optional</span> List<<a href="#type_SourceChange">SourceChange</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -1283,7 +1290,7 @@ dt.typeDefinition {
|
| The length of the code for which assists are being
|
| requested.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>assists ( List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>assists ( <span style="color:#999999">optional</span> List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The assists that are available at the given location.
|
| @@ -1300,7 +1307,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>kinds</b>": List<<a href="#type_RefactoringKind">RefactoringKind</a>>
|
| + "<b>kinds</b>": <span style="color:#999999">optional</span> List<<a href="#type_RefactoringKind">RefactoringKind</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -1327,7 +1334,7 @@ dt.typeDefinition {
|
| The length of the code on which the refactoring would be
|
| based.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( List<<a href="#type_RefactoringKind">RefactoringKind</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>kinds ( <span style="color:#999999">optional</span> List<<a href="#type_RefactoringKind">RefactoringKind</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The kinds of refactorings that are valid for the given
|
| @@ -1344,7 +1351,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>fixes</b>": List<<a href="#type_ErrorFixes">ErrorFixes</a>>
|
| + "<b>fixes</b>": <span style="color:#999999">optional</span> List<<a href="#type_ErrorFixes">ErrorFixes</a>>
|
| }
|
| }</pre></div>
|
| <p>
|
| @@ -1365,7 +1372,7 @@ dt.typeDefinition {
|
| The offset used to select the errors for which fixes
|
| will be returned.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( List<<a href="#type_ErrorFixes">ErrorFixes</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>fixes ( <span style="color:#999999">optional</span> List<<a href="#type_ErrorFixes">ErrorFixes</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The fixes that are available for each of the analysis
|
| @@ -1392,7 +1399,7 @@ dt.typeDefinition {
|
| "id": String
|
| "error": <span style="color:#999999">optional</span> <a href="#type_Error">Error</a>
|
| "result": {
|
| - "<b>status</b>": List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>
|
| + "<b>status</b>": <span style="color:#999999">optional</span> List<<a href="#type_RefactoringProblem">RefactoringProblem</a>>
|
| "<b>feedback</b>": <span style="color:#999999">optional</span> object
|
| "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_SourceChange">SourceChange</a>
|
| "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List<String>
|
| @@ -1441,7 +1448,7 @@ dt.typeDefinition {
|
| does not require any options or if the values of those
|
| options are not known.
|
| </p>
|
| - </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>status ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>
|
| + </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>status ( <span style="color:#999999">optional</span> List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The status of the refactoring. The array will be empty
|
| @@ -1601,7 +1608,7 @@ dt.typeDefinition {
|
| "id": String
|
| "method": "debug.setSubscriptions"
|
| "params": {
|
| - "<b>subscriptions</b>": List<<a href="#type_DebugService">DebugService</a>>
|
| + "<b>subscriptions</b>": <span style="color:#999999">optional</span> List<<a href="#type_DebugService">DebugService</a>>
|
| }
|
| }</pre><br><pre>response: {
|
| "id": String
|
| @@ -1617,7 +1624,7 @@ dt.typeDefinition {
|
| subscriptions will remain unchanged.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( List<<a href="#type_DebugService">DebugService</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( <span style="color:#999999">optional</span> List<<a href="#type_DebugService">DebugService</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the services being subscribed to.
|
| @@ -1625,7 +1632,7 @@ dt.typeDefinition {
|
| </dd></dl></dd></dl><h3>Notifications</h3><dl><dt class="notification">debug.launchData</dt><dd><div class="box"><pre>notification: {
|
| "event": "debug.launchData"
|
| "params": {
|
| - "<b>executables</b>": List<<a href="#type_ExecutableFile">ExecutableFile</a>>
|
| + "<b>executables</b>": <span style="color:#999999">optional</span> List<<a href="#type_ExecutableFile">ExecutableFile</a>>
|
| "<b>dartToHtml</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>>
|
| "<b>htmlToDart</b>": Map<<a href="#type_FilePath">FilePath</a>, List<<a href="#type_FilePath">FilePath</a>>>
|
| }
|
| @@ -1640,7 +1647,7 @@ dt.typeDefinition {
|
| list of services passed in a debug.setSubscriptions request.
|
| </p>
|
|
|
| - <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( List<<a href="#type_ExecutableFile">ExecutableFile</a>> )</i></b></dt><dd>
|
| + <h4>Parameters</h4><dl><dt class="field"><b><i>executables ( <span style="color:#999999">optional</span> List<<a href="#type_ExecutableFile">ExecutableFile</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the files that are executable in the given
|
| @@ -1844,7 +1851,7 @@ dt.typeDefinition {
|
| <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.
|
| </p>
|
|
|
| - <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd>
|
| + <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class="field"><b><i>edits ( <span style="color:#999999">optional</span> List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The edits to be applied to the file.
|
| @@ -2086,7 +2093,7 @@ dt.typeDefinition {
|
| <p>
|
| The error with which the fixes are associated.
|
| </p>
|
| - </dd><dt class="field"><b><i>fixes ( List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>fixes ( <span style="color:#999999">optional</span> List<<a href="#type_SourceChange">SourceChange</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The fixes associated with the error.
|
| @@ -2269,7 +2276,7 @@ dt.typeDefinition {
|
| all occurrences of the name could be edited simultaneously.
|
| </p>
|
|
|
| - <dl><dt class="field"><b><i>positions ( List<<a href="#type_Position">Position</a>> )</i></b></dt><dd>
|
| + <dl><dt class="field"><b><i>positions ( <span style="color:#999999">optional</span> List<<a href="#type_Position">Position</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The positions of the regions that should be edited
|
| @@ -2281,7 +2288,7 @@ dt.typeDefinition {
|
| The length of the regions that should be edited
|
| simultaneously.
|
| </p>
|
| - </dd><dt class="field"><b><i>suggestions ( List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>suggestions ( <span style="color:#999999">optional</span> List<<a href="#type_LinkedEditSuggestion">LinkedEditSuggestion</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| Pre-computed suggestions for what every region might
|
| @@ -2358,7 +2365,7 @@ dt.typeDefinition {
|
| <p>
|
| The length of the region from which the user can navigate.
|
| </p>
|
| - </dd><dt class="field"><b><i>targets ( List<<a href="#type_Element">Element</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>targets ( <span style="color:#999999">optional</span> List<<a href="#type_Element">Element</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The elements to which the given region is bound. By
|
| @@ -2376,7 +2383,7 @@ dt.typeDefinition {
|
| <p>
|
| The element that was referenced.
|
| </p>
|
| - </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The offsets of the name of the referenced element within
|
| @@ -2595,7 +2602,7 @@ dt.typeDefinition {
|
| reference to a method m from an unknown class were found,
|
| it would be marked as being a potential match.
|
| </p>
|
| - </dd><dt class="field"><b><i>path ( List<<a href="#type_Element">Element</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>path ( <span style="color:#999999">optional</span> List<<a href="#type_Element">Element</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The elements that contain the result, starting with the
|
| @@ -2659,13 +2666,13 @@ dt.typeDefinition {
|
| <p>
|
| A human-readable description of the change to be applied.
|
| </p>
|
| - </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceFileEdit">SourceFileEdit</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>edits ( <span style="color:#999999">optional</span> List<<a href="#type_SourceFileEdit">SourceFileEdit</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the edits used to effect the change, grouped by
|
| file.
|
| </p>
|
| - </dd><dt class="field"><b><i>linkedEditGroups ( List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>linkedEditGroups ( <span style="color:#999999">optional</span> List<<a href="#type_LinkedEditGroup">LinkedEditGroup</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the linked editing groups used to customize
|
| @@ -2723,7 +2730,7 @@ dt.typeDefinition {
|
| <p>
|
| The file containing the code to be modified.
|
| </p>
|
| - </dd><dt class="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>edits ( <span style="color:#999999">optional</span> List<<a href="#type_SourceEdit">SourceEdit</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| A list of the edits used to effect the change.
|
| @@ -2762,21 +2769,21 @@ dt.typeDefinition {
|
| this class. This field will be omitted if this item
|
| represents the class Object.
|
| </p>
|
| - </dd><dt class="field"><b><i>interfaces ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>interfaces ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The indexes of the items representing the interfaces
|
| implemented by this class. The list will be empty if
|
| there are no implemented interfaces.
|
| </p>
|
| - </dd><dt class="field"><b><i>mixins ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>mixins ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The indexes of the items representing the mixins
|
| referenced by this class. The list will be empty if
|
| there are no classes mixed in to this class.
|
| </p>
|
| - </dd><dt class="field"><b><i>subclasses ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>subclasses ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The indexes of the items representing the subtypes of
|
| @@ -2834,18 +2841,18 @@ dt.typeDefinition {
|
| </p>
|
|
|
|
|
| - <h4>Feedback</h4><dl><dt class="field"><b><i>names ( List<String> )</i></b></dt><dd>
|
| + <h4>Feedback</h4><dl><dt class="field"><b><i>names ( <span style="color:#999999">optional</span> List<String> )</i></b></dt><dd>
|
|
|
| <p>
|
| The proposed names for the local variable.
|
| </p>
|
| - </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The offsets of the expressions that would be replaced by
|
| a reference to the variable.
|
| </p>
|
| - </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>lengths ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The lengths of the expressions that would be replaced by
|
| @@ -2898,7 +2905,7 @@ dt.typeDefinition {
|
| <p>
|
| The proposed return type for the method.
|
| </p>
|
| - </dd><dt class="field"><b><i>names ( List<String> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>names ( <span style="color:#999999">optional</span> List<String> )</i></b></dt><dd>
|
|
|
| <p>
|
| The proposed names for the method.
|
| @@ -2908,7 +2915,7 @@ dt.typeDefinition {
|
| <p>
|
| True if a getter could be created rather than a method.
|
| </p>
|
| - </dd><dt class="field"><b><i>parameters ( List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">optional</span> List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The proposed parameters for the method.
|
| @@ -2918,13 +2925,13 @@ dt.typeDefinition {
|
| <p>
|
| The number of times the expression or statements occurs.
|
| </p>
|
| - </dd><dt class="field"><b><i>offsets ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>offsets ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The offsets of the expressions or statements that would
|
| be replaced by an invocation of the method.
|
| </p>
|
| - </dd><dt class="field"><b><i>lengths ( List<int> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>lengths ( <span style="color:#999999">optional</span> List<int> )</i></b></dt><dd>
|
|
|
| <p>
|
| The lengths of the expressions or statements that would
|
| @@ -2951,7 +2958,7 @@ dt.typeDefinition {
|
| <p>
|
| The name that the method should be given.
|
| </p>
|
| - </dd><dt class="field"><b><i>parameters ( List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>
|
| + </dd><dt class="field"><b><i>parameters ( <span style="color:#999999">optional</span> List<<a href="#type_RefactoringMethodParameter">RefactoringMethodParameter</a>> )</i></b></dt><dd>
|
|
|
| <p>
|
| The parameters that should be defined for the method.
|
|
|