DocSourcePositions.java revision 3193:3b3bea483542 
1/*
2 * Copyright (c) 2013, 2014, 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
26package com.sun.source.util;
27
28import com.sun.source.doctree.DocCommentTree;
29import com.sun.source.doctree.DocTree;
30import com.sun.source.tree.CompilationUnitTree;
31
32/**
33 * Provides methods to obtain the position of a DocTree within a javadoc comment.
34 * A position is defined as a simple character offset from the start of a
35 * CompilationUnit where the first character is at offset 0.
36 *
37 * @since 1.8
38 */
39public interface DocSourcePositions extends SourcePositions {
40
41    /**
42     * Returns the starting position of the tree within the comment within the file.  If tree is not found within
43     * file, or if the starting position is not available,
44     * return {@link javax.tools.Diagnostic#NOPOS}.
45     * The given tree should be under the given comment tree, and the given documentation
46     * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
47     * for a tree under the given file.
48     * The returned position must be at the start of the yield of this tree, that
49     * is for any sub-tree of this tree, the following must hold:
50     *
51     * <p>
52     * {@code tree.getStartPosition() <= subtree.getStartPosition()} or <br>
53     * {@code tree.getStartPosition() == NOPOS} or <br>
54     * {@code subtree.getStartPosition() == NOPOS}
55     * </p>
56     *
57     * @param file CompilationUnit in which to find tree.
58     * @param comment the comment tree that encloses the tree for which the
59     *                position is being sought
60     * @param tree tree for which a position is sought.
61     * @return the start position of tree.
62     */
63    long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree);
64
65    /**
66     * Returns the ending position of the tree within the comment within the file.  If tree is not found within
67     * file, or if the ending position is not available,
68     * return {@link javax.tools.Diagnostic#NOPOS}.
69     * The given tree should be under the given comment tree, and the given documentation
70     * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
71     * for a tree under the given file.
72     * The returned position must be at the end of the yield of this tree,
73     * that is for any sub-tree of this tree, the following must hold:
74     *
75     * <p>
76     * {@code tree.getEndPosition() >= subtree.getEndPosition()} or <br>
77     * {@code tree.getEndPosition() == NOPOS} or <br>
78     * {@code subtree.getEndPosition() == NOPOS}
79     * </p>
80     *
81     * In addition, the following must hold:
82     *
83     * <p>
84     * {@code tree.getStartPosition() <= tree.getEndPosition()}  or <br>
85     * {@code tree.getStartPosition() == NOPOS} or <br>
86     * {@code tree.getEndPosition() == NOPOS}
87     * </p>
88     *
89     * @param file CompilationUnit in which to find tree.
90     * @param comment the comment tree that encloses the tree for which the
91     *                position is being sought
92     * @param tree tree for which a position is sought.
93     * @return the start position of tree.
94     */
95    long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree);
96
97}
98