Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/source/tree/LineMap.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/source/tree/LineMap.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 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.tree; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * Provides methods to convert between character positions and line numbers |
| duke@1 | 30 | * for a compilation unit. |
| duke@1 | 31 | * |
| duke@1 | 32 | * @since 1.6 |
| duke@1 | 33 | */ |
| duke@1 | 34 | public interface LineMap { |
| duke@1 | 35 | /** |
| duke@1 | 36 | * Find the start position of a line. |
| duke@1 | 37 | * |
| duke@1 | 38 | * @param line line number (beginning at 1) |
| duke@1 | 39 | * @return position of first character in line |
| duke@1 | 40 | * @throws IndexOutOfBoundsException |
| duke@1 | 41 | * if <tt>lineNumber < 1</tt> |
| duke@1 | 42 | * if <tt>lineNumber > no. of lines</tt> |
| duke@1 | 43 | */ |
| duke@1 | 44 | long getStartPosition(long line); |
| duke@1 | 45 | |
| duke@1 | 46 | /** |
| duke@1 | 47 | * Find the position corresponding to a (line,column). |
| duke@1 | 48 | * |
| duke@1 | 49 | * @param line line number (beginning at 1) |
| duke@1 | 50 | * @param column tab-expanded column number (beginning 1) |
| duke@1 | 51 | * |
| duke@1 | 52 | * @return position of character |
| duke@1 | 53 | * @throws IndexOutOfBoundsException |
| duke@1 | 54 | * if {@code line < 1} |
| duke@1 | 55 | * if {@code line > no. of lines} |
| duke@1 | 56 | */ |
| duke@1 | 57 | long getPosition(long line, long column); |
| duke@1 | 58 | |
| duke@1 | 59 | /** |
| duke@1 | 60 | * Find the line containing a position; a line termination |
| duke@1 | 61 | * character is on the line it terminates. |
| duke@1 | 62 | * |
| duke@1 | 63 | * @param pos character offset of the position |
| duke@1 | 64 | * @return the line number of pos (first line is 1) |
| duke@1 | 65 | */ |
| duke@1 | 66 | long getLineNumber(long pos); |
| duke@1 | 67 | |
| duke@1 | 68 | /** |
| duke@1 | 69 | * Find the column for a character position. |
| duke@1 | 70 | * Tab characters preceding the position on the same line |
| duke@1 | 71 | * will be expanded when calculating the column number. |
| duke@1 | 72 | * |
| duke@1 | 73 | * @param pos character offset of the position |
| duke@1 | 74 | * @return the tab-expanded column number of pos (first column is 1) |
| duke@1 | 75 | */ |
| duke@1 | 76 | long getColumnNumber(long pos); |
| duke@1 | 77 | |
| duke@1 | 78 | } |
