FileDocCategorySizeDatePackage
LineMap.javaAPI DocJava SE 6 API1927Tue Jun 10 00:23:24 BST 2008com.sun.source.tree

LineMap

public interface LineMap
Provides methods to convert between character positions and line numbers for a compilation unit.
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public longgetColumnNumber(long pos)
Find the column for a character position. Tab characters preceding the position on the same line will be expanded when calculating the column number.

param
pos character offset of the position
return
the tab-expanded column number of pos (first column is 1)

public longgetLineNumber(long pos)
Find the line containing a position; a line termination character is on the line it terminates.

param
pos character offset of the position
return
the line number of pos (first line is 1)

public longgetPosition(long line, long column)
Find the position corresponding to a (line,column).

param
line line number (beginning at 1)
param
column tab-expanded column number (beginning 1)
return
position of character
throws
IndexOutOfBoundsException if {@code line < 1} if {@code line > no. of lines}

public longgetStartPosition(long line)
Find the start position of a line.

param
line line number (beginning at 1)
return
position of first character in line
throws
IndexOutOfBoundsException if lineNumber < 1 if lineNumber > no. of lines