Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/source/util/SourcePositions.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/source/util/SourcePositions.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.source.util; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.source.tree.*; |
| duke@1 | 29 | |
| duke@1 | 30 | /** |
| duke@1 | 31 | * Provides methods to obtain the position of a Tree within a CompilationUnit. |
| duke@1 | 32 | * A position is defined as a simple character offset from the start of a |
| duke@1 | 33 | * CompilationUnit where the first character is at offset 0. |
| duke@1 | 34 | * |
| duke@1 | 35 | * @author Peter von der Ahé |
| duke@1 | 36 | * @since 1.6 |
| duke@1 | 37 | */ |
| duke@1 | 38 | public interface SourcePositions { |
| duke@1 | 39 | |
| duke@1 | 40 | /** |
| duke@1 | 41 | * Gets the starting position of tree within file. If tree is not found within |
| duke@1 | 42 | * file, or if the starting position is not available, |
| duke@1 | 43 | * return {@link javax.tools.Diagnostic#NOPOS}. |
| duke@1 | 44 | * The returned position must be at the start of the yield of this tree, that |
| duke@1 | 45 | * is for any sub-tree of this tree, the following must hold: |
| duke@1 | 46 | * |
| duke@1 | 47 | * <p> |
| duke@1 | 48 | * {@code tree.getStartPosition() <= subtree.getStartPosition()} or <br> |
| duke@1 | 49 | * {@code tree.getStartPosition() == NOPOS} or <br> |
| duke@1 | 50 | * {@code subtree.getStartPosition() == NOPOS} |
| duke@1 | 51 | * </p> |
| duke@1 | 52 | * |
| duke@1 | 53 | * @param file CompilationUnit in which to find tree. |
| duke@1 | 54 | * @param tree tree for which a position is sought. |
| duke@1 | 55 | * @return the start position of tree. |
| duke@1 | 56 | */ |
| duke@1 | 57 | long getStartPosition(CompilationUnitTree file, Tree tree); |
| duke@1 | 58 | |
| duke@1 | 59 | /** |
| duke@1 | 60 | * Gets the ending position of tree within file. If tree is not found within |
| duke@1 | 61 | * file, or if the starting position is not available, |
| duke@1 | 62 | * return {@link javax.tools.Diagnostic#NOPOS}. |
| duke@1 | 63 | * The returned position must be at the end of the yield of this tree, |
| duke@1 | 64 | * that is for any sub-tree of this tree, the following must hold: |
| duke@1 | 65 | * |
| duke@1 | 66 | * <p> |
| duke@1 | 67 | * {@code tree.getEndPosition() >= subtree.getEndPosition()} or <br> |
| duke@1 | 68 | * {@code tree.getEndPosition() == NOPOS} or <br> |
| duke@1 | 69 | * {@code subtree.getEndPosition() == NOPOS} |
| duke@1 | 70 | * </p> |
| duke@1 | 71 | * |
| duke@1 | 72 | * In addition, the following must hold: |
| duke@1 | 73 | * |
| duke@1 | 74 | * <p> |
| duke@1 | 75 | * {@code tree.getStartPosition() <= tree.getEndPosition()} or <br> |
| duke@1 | 76 | * {@code tree.getStartPosition() == NOPOS} or <br> |
| duke@1 | 77 | * {@code tree.getEndPosition() == NOPOS} |
| duke@1 | 78 | * </p> |
| duke@1 | 79 | * |
| duke@1 | 80 | * @param file CompilationUnit in which to find tree. |
| duke@1 | 81 | * @param tree tree for which a position is sought. |
| duke@1 | 82 | * @return the end position of tree. |
| duke@1 | 83 | */ |
| duke@1 | 84 | long getEndPosition(CompilationUnitTree file, Tree tree); |
| duke@1 | 85 | |
| duke@1 | 86 | } |
