src/jdk.compiler/share/classes/com/sun/source/tree/LineMap.java

Print this page




  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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.tree;
  27 
  28 /**
  29  * Provides methods to convert between character positions and line numbers
  30  * for a compilation unit.
  31  *
  32  * @since 1.6
  33  */
  34 @jdk.Exported
  35 public interface LineMap {
  36     /**
  37      * Finds the start position of a line.
  38      *
  39      * @param line line number (beginning at 1)
  40      * @return     position of first character in line
  41      * @throws  IndexOutOfBoundsException
  42      *           if {@code lineNumber < 1}
  43      *           if {@code lineNumber > no. of lines}
  44      */
  45     long getStartPosition(long line);
  46 
  47     /**
  48      * Finds the position corresponding to a (line,column).
  49      *
  50      * @param   line    line number (beginning at 1)
  51      * @param   column  tab-expanded column number (beginning 1)
  52      *
  53      * @return  position of character
  54      * @throws  IndexOutOfBoundsException




  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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.tree;
  27 
  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      * Finds 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 {@code lineNumber < 1}
  42      *           if {@code lineNumber > no. of lines}
  43      */
  44     long getStartPosition(long line);
  45 
  46     /**
  47      * Finds 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