< prev index next >

nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/api/tree/LineMap.java

Print this page




  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 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 jdk.nashorn.api.tree;
  27 
  28 /**
  29  * Provides methods to convert between character positions and line numbers
  30  * for a compilation unit.
  31  *
  32  * @since 1.9
  33  */
  34 public interface LineMap {
  35     /**
  36      * Find the line containing a position; a line termination
  37      * character is on the line it terminates.
  38      *
  39      * @param   pos  character offset of the position
  40      * @return the line number of pos (first line is 1)
  41      */
  42     long getLineNumber(long pos);
  43 
  44     /**
  45      * Find the column for a character position.
  46      * Tab characters preceding the position on the same line
  47      * will be expanded when calculating the column number.
  48      *
  49      * @param  pos   character offset of the position
  50      * @return       the tab-expanded column number of pos (first column is 1)
  51      */
  52     long getColumnNumber(long pos);


  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 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 jdk.nashorn.api.tree;
  27 
  28 /**
  29  * Provides methods to convert between character positions and line numbers
  30  * for a compilation unit.
  31  *
  32  * @since 9
  33  */
  34 public interface LineMap {
  35     /**
  36      * Find the line containing a position; a line termination
  37      * character is on the line it terminates.
  38      *
  39      * @param   pos  character offset of the position
  40      * @return the line number of pos (first line is 1)
  41      */
  42     long getLineNumber(long pos);
  43 
  44     /**
  45      * Find the column for a character position.
  46      * Tab characters preceding the position on the same line
  47      * will be expanded when calculating the column number.
  48      *
  49      * @param  pos   character offset of the position
  50      * @return       the tab-expanded column number of pos (first column is 1)
  51      */
  52     long getColumnNumber(long pos);
< prev index next >