langtools/src/share/classes/com/sun/source/tree/LineMap.java
author ohair
Tue, 25 May 2010 15:54:51 -0700
changeset 5520 86e4b9a9da40
parent 10 06bc494ca11e
child 13844 56339cf983a3
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     2
 * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.source.tree;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * Provides methods to convert between character positions and line numbers
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * for a compilation unit.
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
public interface LineMap {
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
     * Find the start position of a line.
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
     * @param line line number (beginning at 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
     * @return     position of first character in line
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
     * @throws  IndexOutOfBoundsException
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
     *           if <tt>lineNumber < 1</tt>
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
     *           if <tt>lineNumber > no. of lines</tt>
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    long getStartPosition(long line);
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
     * Find the position corresponding to a (line,column).
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
     * @param   line    line number (beginning at 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
     * @param   column  tab-expanded column number (beginning 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
     * @return  position of character
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
     * @throws  IndexOutOfBoundsException
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
     *           if {@code line < 1}
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
     *           if {@code line > no. of lines}
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    long getPosition(long line, long column);
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
     * Find the line containing a position; a line termination
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
     * character is on the line it terminates.
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     * @param   pos  character offset of the position
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     * @return the line number of pos (first line is 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    long getLineNumber(long pos);
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
     * Find the column for a character position.
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
     * Tab characters preceding the position on the same line
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
     * will be expanded when calculating the column number.
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * @param  pos   character offset of the position
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     * @return       the tab-expanded column number of pos (first column is 1)
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    long getColumnNumber(long pos);
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
}