pkg/analysis_server/doc/api.html - Issue 576473003: Split refactoring problems into init, options and final.

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 576473003: Split refactoring problems into init, options and final. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 6 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/refactoring/ServerRenameRefactoring.java ('k') | pkg/analysis_server/lib/src/edit/edit_domain.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1 <html><head>	1 <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 1380 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
1391 "<b>file</b>": <a href="#type_FilePath">FilePath</a>	1391 "<b>file</b>": <a href="#type_FilePath">FilePath</a>

1392 "<b>offset</b>": int	1392 "<b>offset</b>": int

1393 "<b>length</b>": int	1393 "<b>length</b>": int

1394 "<b>validateOnly</b>": bool	1394 "<b>validateOnly</b>": bool

1395 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>	1395 "<b>options</b>": <span style="color:#999999">optional</span> <a href="#type _RefactoringOptions">RefactoringOptions</a>

1396 }	1396 }

1397 }</pre><br><pre>response: {	1397 }</pre><br><pre>response: {

1398 "id": String	1398 "id": String

1399 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>	1399 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>

1400 "result": {	1400 "result": {

1401 "<b>problems</b>": List<<a href="#type_RefactoringProblem">RefactoringPro blem</a>>	1401 "<b>initialProblems</b>": List<<a href="#type_RefactoringProblem">Refacto ringProblem</a>>

	1402 "<b>optionsProblems</b>": List<<a href="#type_RefactoringProblem">Refacto ringProblem</a>>

	1403 "<b>finalProblems</b>": List<<a href="#type_RefactoringProblem">Refactori ngProblem</a>>

1402 "<b>feedback</b>": <span style="color:#999999">optional</span> <a href="#typ e_RefactoringFeedback">RefactoringFeedback</a>	1404 "<b>feedback</b>": <span style="color:#999999">optional</span> <a href="#typ e_RefactoringFeedback">RefactoringFeedback</a>

1403 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a>	1405 "<b>change</b>": <span style="color:#999999">optional</span> <a href="#type_ SourceChange">SourceChange</a>

1404 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String>	1406 "<b>potentialEdits</b>": <span style="color:#999999">optional</span> List&lt ;String>

1405 }	1407 }

1406 }</pre></div>	1408 }</pre></div>

1407 <p>	1409 <p>

1408 Get the changes required to perform a refactoring.	1410 Get the changes required to perform a refactoring.

1409 </p>	1411 </p>

1410	1412

1411	1413

(...skipping 28 matching lines...) Expand all Loading...
1440	1442

1441 <p>	1443 <p>

1442 Data used to provide values provided by the user. The	1444 Data used to provide values provided by the user. The

1443 structure of the data is dependent on the kind of	1445 structure of the data is dependent on the kind of

1444 refactoring being performed. The data that is expected is	1446 refactoring being performed. The data that is expected is

1445 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as	1447 documented in the section titled <a href="#refactorings">Refactori ngs</a>, labeled as

1446 “Options”. This field can be omitted if the refactoring	1448 “Options”. This field can be omitted if the refactoring

1447 does not require any options or if the values of those	1449 does not require any options or if the values of those

1448 options are not known.	1450 options are not known.

1449 </p>	1451 </p>

1450 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>problems ( List& lt;<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b></dt>< dd>	1452 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>initialProblems ( List<<a href="#type_RefactoringProblem">RefactoringProblem</a>> )</i></b ></dt><dd>

1451	1453

1452 <p>	1454 <p>

1453 The status of the refactoring. The array will be empty	1455 The initial status of the refactoring, i.e. problems related to

1454 if there are no known problems.	1456 the context in which the refactoring is requested.

	1457 The array will be empty if there are no known problems.

	1458 </p>

	1459 </dd><dt class="field"><b><i>optionsProblems ( List<<a href="#type_ RefactoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>

	1460

	1461 <p>

	1462 The options validation status, i.e. problems in the given options,

	1463 such as light-weight validation of a new name, flags

	1464 compatibility, etc.

	1465 The array will be empty if there are no known problems.

	1466 </p>

	1467 </dd><dt class="field"><b><i>finalProblems ( List<<a href="#type_Re factoringProblem">RefactoringProblem</a>> )</i></b></dt><dd>

	1468

	1469 <p>

	1470 The final status of the refactoring, i.e. problems identified in

	1471 the result of a full, potentially expensive validation and / or

	1472 change creation.

	1473 The array will be empty if there are no known problems.

1455 </p>	1474 </p>

1456 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op tional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a> )</i>< /b></dt><dd>	1475 </dd><dt class="field"><b><i>feedback ( <span style="color:#999999">op tional</span> <a href="#type_RefactoringFeedback">RefactoringFeedback</a> )</i>< /b></dt><dd>

1457	1476

1458 <p>	1477 <p>

1459 Data used to provide feedback to the user. The structure	1478 Data used to provide feedback to the user. The structure

1460 of the data is dependent on the kind of refactoring	1479 of the data is dependent on the kind of refactoring

1461 being created. The data that is returned is documented	1480 being created. The data that is returned is documented

1462 in the section titled <a href="#refactorings">Refactorings</a>, la beled as	1481 in the section titled <a href="#refactorings">Refactorings</a>, la beled as

1463 “Feedback”.	1482 “Feedback”.

1464 </p>	1483 </p>

(...skipping 1712 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3177 <p>	3196 <p>

3178 This section contains a list of all of the errors that are	3197 This section contains a list of all of the errors that are

3179 produced by the server and the data that is returned with each.	3198 produced by the server and the data that is returned with each.

3180 </p>	3199 </p>

3181 <p>	3200 <p>

3182 TBD	3201 TBD

3183 </p>	3202 </p>

3184	3203

3185	3204

3186 </body></html>	3205 </body></html>

OLD	NEW