OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2014, the Dart project authors. | 2 * Copyright (c) 2014, the Dart project authors. |
3 * | 3 * |
4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u
se this file except | 4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u
se this file except |
5 * in compliance with the License. You may obtain a copy of the License at | 5 * in compliance with the License. You may obtain a copy of the License at |
6 * | 6 * |
7 * http://www.eclipse.org/legal/epl-v10.html | 7 * http://www.eclipse.org/legal/epl-v10.html |
8 * | 8 * |
9 * Unless required by applicable law or agreed to in writing, software distribut
ed under the License | 9 * Unless required by applicable law or agreed to in writing, software distribut
ed under the License |
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K
IND, either express | 10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K
IND, either express |
(...skipping 87 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
98 * request will be delayed until it has been computed. If the content of the f
ile changes after | 98 * request will be delayed until it has been computed. If the content of the f
ile changes after |
99 * this request was received but before a response could be sent, then an erro
r of type | 99 * this request was received but before a response could be sent, then an erro
r of type |
100 * CONTENT_MODIFIED will be generated. | 100 * CONTENT_MODIFIED will be generated. |
101 * | 101 * |
102 * If a navigation region overlaps (but extends either before or after) the gi
ven region of the | 102 * If a navigation region overlaps (but extends either before or after) the gi
ven region of the |
103 * file it will be included in the result. This means that it is theoretically
possible to get the | 103 * file it will be included in the result. This means that it is theoretically
possible to get the |
104 * same navigation region in response to multiple requests. Clients can avoid
this by always | 104 * same navigation region in response to multiple requests. Clients can avoid
this by always |
105 * choosing a region that starts at the beginning of a line and ends at the en
d of a (possibly | 105 * choosing a region that starts at the beginning of a line and ends at the en
d of a (possibly |
106 * different) line in the file. | 106 * different) line in the file. |
107 * | 107 * |
| 108 * If a request is made for a file which does not exist, or which is not curre
ntly subject to |
| 109 * analysis (e.g. because it is not associated with any analysis root specifie
d to |
| 110 * analysis.setAnalysisRoots), an error of type GET_NAVIGATION_INVALID_FILE wi
ll be generated. |
| 111 * |
108 * @param file The file in which navigation information is being requested. | 112 * @param file The file in which navigation information is being requested. |
109 * @param offset The offset of the region for which navigation information is
being requested. | 113 * @param offset The offset of the region for which navigation information is
being requested. |
110 * @param length The length of the region for which navigation information is
being requested. | 114 * @param length The length of the region for which navigation information is
being requested. |
111 */ | 115 */ |
112 public void analysis_getNavigation(String file, int offset, int length, GetNav
igationConsumer consumer); | 116 public void analysis_getNavigation(String file, int offset, int length, GetNav
igationConsumer consumer); |
113 | 117 |
114 /** | 118 /** |
115 * {@code analysis.reanalyze} | 119 * {@code analysis.reanalyze} |
116 * | 120 * |
117 * Force the re-analysis of everything contained in the specified analysis roo
ts. This will cause | 121 * Force the re-analysis of everything contained in the specified analysis roo
ts. This will cause |
(...skipping 394 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
512 * the response to this request has been sent. | 516 * the response to this request has been sent. |
513 */ | 517 */ |
514 public void server_shutdown(); | 518 public void server_shutdown(); |
515 | 519 |
516 /** | 520 /** |
517 * Start the analysis server. | 521 * Start the analysis server. |
518 */ | 522 */ |
519 public void start() throws Exception; | 523 public void start() throws Exception; |
520 | 524 |
521 } | 525 } |
OLD | NEW |