author | alanb |
Fri, 08 Jan 2016 11:47:12 +0000 | |
changeset 34916 | 16043fc1d90b |
parent 25874 | 83c19f00452c |
permissions | -rw-r--r-- |
10 | 1 |
/* |
25287 | 2 |
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved. |
10 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5520 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.source.util; |
|
27 |
||
28 |
import com.sun.source.tree.*; |
|
29 |
||
30 |
/** |
|
31 |
* Provides methods to obtain the position of a Tree within a CompilationUnit. |
|
32 |
* A position is defined as a simple character offset from the start of a |
|
33 |
* CompilationUnit where the first character is at offset 0. |
|
34 |
* |
|
35 |
* @author Peter von der Ahé |
|
36 |
* @since 1.6 |
|
37 |
*/ |
|
38 |
public interface SourcePositions { |
|
39 |
||
40 |
/** |
|
25287 | 41 |
* Returns the starting position of tree within file. If tree is not found within |
10 | 42 |
* file, or if the starting position is not available, |
43 |
* return {@link javax.tools.Diagnostic#NOPOS}. |
|
44 |
* The returned position must be at the start of the yield of this tree, that |
|
45 |
* is for any sub-tree of this tree, the following must hold: |
|
46 |
* |
|
47 |
* <p> |
|
48 |
* {@code tree.getStartPosition() <= subtree.getStartPosition()} or <br> |
|
49 |
* {@code tree.getStartPosition() == NOPOS} or <br> |
|
50 |
* {@code subtree.getStartPosition() == NOPOS} |
|
51 |
* </p> |
|
52 |
* |
|
53 |
* @param file CompilationUnit in which to find tree. |
|
54 |
* @param tree tree for which a position is sought. |
|
55 |
* @return the start position of tree. |
|
56 |
*/ |
|
57 |
long getStartPosition(CompilationUnitTree file, Tree tree); |
|
58 |
||
59 |
/** |
|
25287 | 60 |
* Returns the ending position of tree within file. If tree is not found within |
17273
d7ec6654aac9
8008174: DocTree API should provide start and end positions for tree nodes
jlahoda
parents:
16303
diff
changeset
|
61 |
* file, or if the ending position is not available, |
10 | 62 |
* return {@link javax.tools.Diagnostic#NOPOS}. |
63 |
* The returned position must be at the end of the yield of this tree, |
|
64 |
* that is for any sub-tree of this tree, the following must hold: |
|
65 |
* |
|
66 |
* <p> |
|
67 |
* {@code tree.getEndPosition() >= subtree.getEndPosition()} or <br> |
|
68 |
* {@code tree.getEndPosition() == NOPOS} or <br> |
|
69 |
* {@code subtree.getEndPosition() == NOPOS} |
|
70 |
* </p> |
|
71 |
* |
|
72 |
* In addition, the following must hold: |
|
73 |
* |
|
74 |
* <p> |
|
75 |
* {@code tree.getStartPosition() <= tree.getEndPosition()} or <br> |
|
76 |
* {@code tree.getStartPosition() == NOPOS} or <br> |
|
77 |
* {@code tree.getEndPosition() == NOPOS} |
|
78 |
* </p> |
|
79 |
* |
|
80 |
* @param file CompilationUnit in which to find tree. |
|
81 |
* @param tree tree for which a position is sought. |
|
82 |
* @return the end position of tree. |
|
83 |
*/ |
|
84 |
long getEndPosition(CompilationUnitTree file, Tree tree); |
|
85 |
||
86 |
} |