source/mir/misc/Location.java

   1 /*
   2  * Copyright (C) 2001, 2002  The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.misc;
  33
  34 /**
  35  * Stores the file name and line number in a file.
  36  *
  37  * @version $Id: Location.java,v 1.2 2002/09/01 22:05:50 mh Exp $
  38  *
  39  */
  40 public class Location {
  41     private String fileName;
  42     private int lineNumber;
  43     private int columnNumber;
  44
  45     public static final Location UNKNOWN_LOCATION = new Location();
  46
  47     /**
  48      * Creates an "unknown" location.
  49      */
  50     private Location() {
  51         this(null, 0, 0);
  52     }
  53
  54     /**
  55      * Creates a location consisting of a file name but no line number.
  56      */
  57     public Location(String fileName) {
  58         this(fileName, 0, 0);
  59     }
  60
  61     /**
  62      * Creates a location consisting of a file name and line number.
  63      */
  64     public Location(String fileName, int lineNumber, int columnNumber) {
  65         this.fileName = fileName;
  66         this.lineNumber = lineNumber;
  67         this.columnNumber = columnNumber;
  68     }
  69
  70     /**
  71      * Returns the file name, line number and a trailing space. An error
  72      * message can be appended easily. For unknown locations, returns
  73      * an empty string.
  74      */
  75     public String toString() {
  76         StringBuffer buf = new StringBuffer();
  77
  78         if (fileName != null) {
  79             buf.append(fileName);
  80
  81             if (lineNumber != 0) {
  82                 buf.append(":");
  83                 buf.append(lineNumber);
  84             }
  85
  86             buf.append(": ");
  87         }
  88
  89         return buf.toString();
  90     }
  91 }