jdk8-mips64-public/langtools: src/share/classes/com/sun/source/tree/LineMap.java@664edca41e34

6855544: add missing files
Reviewed-by: jjg, mcimadamore, darcy
Contributed-by: mernst@cs.washington.edu, mali@csail.mit.edu, mpapi@csail.mit.edu

     1 /*

     2  * Copyright 2006 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    26 package com.sun.source.tree;

    28 /**

    29  * Provides methods to convert between character positions and line numbers

    30  * for a compilation unit.

    31  *

    32  * @since 1.6

    33  */

    34 public interface LineMap {

    35     /**

    36      * Find the start position of a line.

    37      *

    38      * @param line line number (beginning at 1)

    39      * @return     position of first character in line

    40      * @throws  IndexOutOfBoundsException

    41      *           if <tt>lineNumber < 1</tt>

    42      *           if <tt>lineNumber > no. of lines</tt>

    43      */

    44     long getStartPosition(long line);

    46     /**

    47      * Find the position corresponding to a (line,column).

    48      *

    49      * @param   line    line number (beginning at 1)

    50      * @param   column  tab-expanded column number (beginning 1)

    51      *

    52      * @return  position of character

    53      * @throws  IndexOutOfBoundsException

    54      *           if {@code line < 1}

    55      *           if {@code line > no. of lines}

    56      */

    57     long getPosition(long line, long column);

    59     /**

    60      * Find the line containing a position; a line termination

    61      * character is on the line it terminates.

    62      *

    63      * @param   pos  character offset of the position

    64      * @return the line number of pos (first line is 1)

    65      */

    66     long getLineNumber(long pos);

    68     /**

    69      * Find the column for a character position.

    70      * Tab characters preceding the position on the same line

    71      * will be expanded when calculating the column number.

    72      *

    73      * @param  pos   character offset of the position

    74      * @return       the tab-expanded column number of pos (first column is 1)

    75      */

    76     long getColumnNumber(long pos);

    78 }

Mercurial > jdk8-mips64-public > langtools / file revision