1 /*
   2  * Copyright 2004 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  */
  25 
  26 package com.sun.mirror.util;
  27 
  28 
  29 import java.io.File;
  30 
  31 
  32 /**
  33  * Represents a position in a source file.
  34  *
  35  * @author Joseph D. Darcy
  36  * @author Scott Seligman
  37  * @since 1.5
  38  */
  39 
  40 public interface SourcePosition {
  41 
  42     /**
  43      * Returns the source file containing this position.
  44      *
  45      * @return the source file containing this position; never null
  46      */
  47     File file();
  48 
  49     /**
  50      * Returns the line number of this position.  Lines are numbered
  51      * starting with 1.
  52      *
  53      * @return the line number of this position, or 0 if the line
  54      * number is unknown or not applicable
  55      */
  56     int line();
  57 
  58     /**
  59      * Returns the column number of this position.  Columns are numbered
  60      * starting with 1.
  61      *
  62      * @return the column number of this position, or 0 if the column
  63      * number is unknown or not applicable
  64      */
  65     int column();
  66 }