source/mir/misc/Location.java

   1 /*
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 1999 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution, if
  20  *    any, must include the following acknowlegement:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowlegement may appear in the software itself,
  24  *    if and wherever such third-party acknowlegements normally appear.
  25  *
  26  * 4. The names "The Jakarta Project", "Ant", and "Apache Software
  27  *    Foundation" must not be used to endorse or promote products derived
  28  *    from this software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache"
  32  *    nor may "Apache" appear in their names without prior written
  33  *    permission of the Apache Group.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  */
  54
  55 package mir.misc;
  56
  57 /**
  58  * Stores the file name and line number in a file.
  59  */
  60 public class Location {
  61     private String fileName;
  62     private int lineNumber;
  63     private int columnNumber;
  64
  65     public static final Location UNKNOWN_LOCATION = new Location();
  66
  67     /**
  68      * Creates an "unknown" location.
  69      */
  70     private Location() {
  71         this(null, 0, 0);
  72     }
  73
  74     /**
  75      * Creates a location consisting of a file name but no line number.
  76      */
  77     public Location(String fileName) {
  78         this(fileName, 0, 0);
  79     }
  80
  81     /**
  82      * Creates a location consisting of a file name and line number.
  83      */
  84     public Location(String fileName, int lineNumber, int columnNumber) {
  85         this.fileName = fileName;
  86         this.lineNumber = lineNumber;
  87         this.columnNumber = columnNumber;
  88     }
  89
  90     /**
  91      * Returns the file name, line number and a trailing space. An error
  92      * message can be appended easily. For unknown locations, returns
  93      * an empty string.
  94      */
  95     public String toString() {
  96         StringBuffer buf = new StringBuffer();
  97
  98         if (fileName != null) {
  99             buf.append(fileName);
 100
 101             if (lineNumber != 0) {
 102                 buf.append(":");
 103                 buf.append(lineNumber);
 104             }
 105
 106             buf.append(": ");
 107         }
 108
 109         return buf.toString();
 110     }
 111 }