1 /*
2 * Copyright (c) 2013, 2021, Oracle and/or its affiliates. All rights reserved.
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
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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 *
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.
24 */
25
26 package com.sun.source.util;
27
28 import com.sun.source.doctree.DocCommentTree;
29 import com.sun.source.doctree.DocTree;
30 import com.sun.source.tree.CompilationUnitTree;
31 import com.sun.source.tree.Tree;
32
33 /**
34 * Provides methods to obtain the position of a DocTree within a javadoc comment.
35 * A position is defined as a simple character offset from the start of a
36 * CompilationUnit where the first character is at offset 0.
37 *
38 * @since 1.8
39 */
40 public interface DocSourcePositions extends SourcePositions {
41
42 /**
43 * Returns the starting position of the tree within the comment within the file. If tree is not found within
44 * file, or if the starting position is not available,
45 * returns {@link javax.tools.Diagnostic#NOPOS}.
46 * The given tree should be under the given comment tree, and the given documentation
47 * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
48 * for a tree under the given file.
49 * The returned position must be at the start of the yield of this tree, that
50 * is for any sub-tree of this tree, the following must hold:
51 *
52 * <p>
53 * {@code getStartPosition(file, comment, tree) <= getStartPosition(file, comment, subtree)} or <br>
54 * {@code getStartPosition(file, comment, tree) == NOPOS} or <br>
55 * {@code getStartPosition(file, comment, subtree) == NOPOS}
56 * </p>
57 *
58 * @param file compilation unit in which to find tree
59 * @param comment the comment tree that encloses the tree for which the
60 * position is being sought
61 * @param tree tree for which a position is sought
62 * @return the start position of tree
63 * @deprecated use {@link #getStartPosition(DocCommentTree, DocTree)} instead
64 */
65 @Deprecated(since = "27", forRemoval = true)
66 default long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) {
67 return getStartPosition(comment, tree);
68 }
69
70 /**
71 * {@return the starting position of the given {@link Tree}. If the starting position is not available, returns
72 * {@link javax.tools.Diagnostic#NOPOS}}
73 *
74 * <p>The given tree should be under the given comment tree. The returned position must be at the start of the
75 * yield of this tree, that is for any sub-tree of this tree, the following must hold:
76 *
77 * <p>
78 * {@code getStartPosition(comment, tree) <= getStartPosition(comment, subtree)} or <br>
79 * {@code getStartPosition(comment, tree) == NOPOS} or <br>
80 * {@code getStartPosition(comment, subtree) == NOPOS}
81 * </p>
82 *
83 * @param comment the comment tree that encloses the tree for which the
84 * position is being sought
85 * @param tree tree for which a position is sought
86 * @since 27
87 */
88 long getStartPosition(DocCommentTree comment, DocTree tree);
89
90 /**
91 * Returns the ending position of the tree within the comment within the file. If tree is not found within
92 * file, or if the ending position is not available,
93 * returns {@link javax.tools.Diagnostic#NOPOS}.
94 * The given tree should be under the given comment tree, and the given documentation
95 * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
96 * for a tree under the given file.
97 * The returned position must be at the end of the yield of this tree,
98 * that is for any sub-tree of this tree, the following must hold:
99 *
100 * <p>
101 * {@code getEndPosition(file, comment, tree) >= getEndPosition(file, comment, subtree)} or <br>
102 * {@code getEndPosition(file, comment, tree) == NOPOS} or <br>
103 * {@code getEndPosition(file, comment, subtree) == NOPOS}
104 * </p>
105 *
106 * In addition, the following must hold:
107 *
108 * <p>
109 * {@code getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree)} or <br>
110 * {@code getStartPosition(file, comment, tree) == NOPOS} or <br>
111 * {@code getEndPosition(file, comment, tree) == NOPOS}
112 * </p>
113 *
114 * @param file compilation unit in which to find tree
115 * @param comment the comment tree that encloses the tree for which the
116 * position is being sought
117 * @param tree tree for which a position is sought
118 * @return the end position of tree
119 * @deprecated use {@link #getEndPosition(DocCommentTree, DocTree)} instead
120 */
121 @Deprecated(since = "27", forRemoval = true)
122 default long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) {
123 return getEndPosition(comment, tree);
124 }
125
126 /**
127 * {@return the ending position of the given {@link Tree}. If the ending position is not available, returns
128 * {@link javax.tools.Diagnostic#NOPOS}}
129 *
130 * <p>The given tree should be under the given comment tree. The returned position must be at the end of the yield
131 * of this tree, that is for any sub-tree of this tree, the following must hold:
132 *
133 * <p>
134 * {@code getEndPosition(comment, tree) >= getEndPosition(comment, subtree)} or <br>
135 * {@code getEndPosition(comment, tree) == NOPOS} or <br>
136 * {@code getEndPosition(comment, subtree) == NOPOS}
137 * </p>
138 *
139 * In addition, the following must hold:
140 *
141 * <p>
142 * {@code getStartPosition(comment, tree) <= getEndPosition(comment, tree)} or <br>
143 * {@code getStartPosition(comment, tree) == NOPOS} or <br>
144 * {@code getEndPosition(comment, tree) == NOPOS}
145 * </p>
146 *
147 * @param comment the comment tree that encloses the tree for which the
148 * position is being sought
149 * @param tree tree for which a position is sought
150 * @since 27
151 */
152 long getEndPosition(DocCommentTree comment, DocTree tree);
153
154 }