Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/source/util/DocSourcePositions.java@2eb010b6cb22 (annotated)
src/share/classes/com/sun/source/util/DocSourcePositions.java
Thu, 31 Aug 2017 15:17:03 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:17:03 +0800
- changeset 2525
- 2eb010b6cb22
- parent 2083
- 379c04c090cf
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.source.util; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.source.doctree.DocCommentTree; |
| aoqi@0 | 29 | import com.sun.source.doctree.DocTree; |
| aoqi@0 | 30 | import com.sun.source.tree.CompilationUnitTree; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * Provides methods to obtain the position of a DocTree within a javadoc comment. |
| aoqi@0 | 34 | * A position is defined as a simple character offset from the start of a |
| aoqi@0 | 35 | * CompilationUnit where the first character is at offset 0. |
| aoqi@0 | 36 | * |
| aoqi@0 | 37 | * @since 1.8 |
| aoqi@0 | 38 | */ |
| aoqi@0 | 39 | @jdk.Exported |
| aoqi@0 | 40 | public interface DocSourcePositions extends SourcePositions { |
| aoqi@0 | 41 | |
| aoqi@0 | 42 | /** |
| aoqi@0 | 43 | * Gets the starting position of the tree within the comment within the file. If tree is not found within |
| aoqi@0 | 44 | * file, or if the starting position is not available, |
| aoqi@0 | 45 | * return {@link javax.tools.Diagnostic#NOPOS}. |
| aoqi@0 | 46 | * The given tree should be under the given comment tree, and the given documentation |
| aoqi@0 | 47 | * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) } |
| aoqi@0 | 48 | * for a tree under the given file. |
| aoqi@0 | 49 | * The returned position must be at the start of the yield of this tree, that |
| aoqi@0 | 50 | * is for any sub-tree of this tree, the following must hold: |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * <p> |
| aoqi@0 | 53 | * {@code tree.getStartPosition() <= subtree.getStartPosition()} or <br> |
| aoqi@0 | 54 | * {@code tree.getStartPosition() == NOPOS} or <br> |
| aoqi@0 | 55 | * {@code subtree.getStartPosition() == NOPOS} |
| aoqi@0 | 56 | * </p> |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * @param file CompilationUnit in which to find tree. |
| aoqi@0 | 59 | * @param comment the comment tree that encloses the tree for which the |
| aoqi@0 | 60 | * position is being sought |
| aoqi@0 | 61 | * @param tree tree for which a position is sought. |
| aoqi@0 | 62 | * @return the start position of tree. |
| aoqi@0 | 63 | */ |
| aoqi@0 | 64 | long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree); |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** |
| aoqi@0 | 67 | * Gets the ending position of the tree within the comment within the file. If tree is not found within |
| aoqi@0 | 68 | * file, or if the ending position is not available, |
| aoqi@0 | 69 | * return {@link javax.tools.Diagnostic#NOPOS}. |
| aoqi@0 | 70 | * The given tree should be under the given comment tree, and the given documentation |
| aoqi@0 | 71 | * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) } |
| aoqi@0 | 72 | * for a tree under the given file. |
| aoqi@0 | 73 | * The returned position must be at the end of the yield of this tree, |
| aoqi@0 | 74 | * that is for any sub-tree of this tree, the following must hold: |
| aoqi@0 | 75 | * |
| aoqi@0 | 76 | * <p> |
| aoqi@0 | 77 | * {@code tree.getEndPosition() >= subtree.getEndPosition()} or <br> |
| aoqi@0 | 78 | * {@code tree.getEndPosition() == NOPOS} or <br> |
| aoqi@0 | 79 | * {@code subtree.getEndPosition() == NOPOS} |
| aoqi@0 | 80 | * </p> |
| aoqi@0 | 81 | * |
| aoqi@0 | 82 | * In addition, the following must hold: |
| aoqi@0 | 83 | * |
| aoqi@0 | 84 | * <p> |
| aoqi@0 | 85 | * {@code tree.getStartPosition() <= tree.getEndPosition()} or <br> |
| aoqi@0 | 86 | * {@code tree.getStartPosition() == NOPOS} or <br> |
| aoqi@0 | 87 | * {@code tree.getEndPosition() == NOPOS} |
| aoqi@0 | 88 | * </p> |
| aoqi@0 | 89 | * |
| aoqi@0 | 90 | * @param file CompilationUnit in which to find tree. |
| aoqi@0 | 91 | * @param comment the comment tree that encloses the tree for which the |
| aoqi@0 | 92 | * position is being sought |
| aoqi@0 | 93 | * @param tree tree for which a position is sought. |
| aoqi@0 | 94 | * @return the start position of tree. |
| aoqi@0 | 95 | */ |
| aoqi@0 | 96 | long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree); |
| aoqi@0 | 97 | |
| aoqi@0 | 98 | } |
