Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 158   Methods: 5
NCLOC: 40   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Location.java 83.3% 93.8% 80% 88.9%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2000,2002-2003 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 "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 org.apache.tools.ant;
 56   
 
 57   
 import java.io.Serializable;
 58   
 import org.apache.tools.ant.util.FileUtils;
 59   
 import org.xml.sax.Locator;
 60   
 
 61   
 /**
 62   
  * Stores the location of a piece of text within a file (file name,
 63   
  * line number and column number). Note that the column number is
 64   
  * currently ignored.
 65   
  */
 66   
 public class Location implements Serializable {
 67   
     
 68   
     /** Name of the file. */
 69   
     private String fileName;
 70   
     /** Line number within the file. */
 71   
     private int lineNumber;
 72   
     /** Column number within the file. */
 73   
     private int columnNumber;
 74   
 
 75   
     /** Location to use when one is needed but no information is available */
 76   
     public static final Location UNKNOWN_LOCATION = new Location();
 77   
 
 78   
     /**
 79   
      * Creates an "unknown" location.
 80   
      */
 81  1
     private Location() {
 82  1
         this(null, 0, 0);
 83   
     }
 84   
 
 85   
     /**
 86   
      * Creates a location consisting of a file name but no line number or
 87   
      * column number.
 88   
      * 
 89   
      * @param fileName The name of the file. May be <code>null</code>,
 90   
      *                 in which case the location is equivalent to
 91   
      *                 {@link #UNKNOWN_LOCATION UNKNOWN_LOCATION}.
 92   
      */
 93  4
     public Location(String fileName) {
 94  4
         this(fileName, 0, 0);
 95   
     }
 96   
 
 97   
     /**
 98   
      * Creates a location from the SAX locator using the system ID as
 99   
      * the filename.
 100   
      * 
 101   
      * @param loc Must not be <code>null</code>.
 102   
      *
 103   
      * @since Ant 1.6
 104   
      */
 105  0
     public Location(Locator loc) {
 106  0
         this(loc.getSystemId(), loc.getLineNumber(), loc.getColumnNumber());
 107   
     }
 108   
 
 109   
     /**
 110   
      * Creates a location consisting of a file name, line number and
 111   
      * column number.
 112   
      * 
 113   
      * @param fileName The name of the file. May be <code>null</code>,
 114   
      *                 in which case the location is equivalent to
 115   
      *                 {@link #UNKNOWN_LOCATION UNKNOWN_LOCATION}.
 116   
      * 
 117   
      * @param lineNumber Line number within the file. Use 0 for unknown
 118   
      *                   positions within a file.
 119   
      * @param columnNumber Column number within the line.
 120   
      */
 121  22092
     public Location(String fileName, int lineNumber, int columnNumber) {
 122  22092
         if (fileName != null && fileName.startsWith("file:")) {
 123  22087
             this.fileName = FileUtils.newFileUtils().fromURI(fileName);
 124   
         } else {
 125  5
             this.fileName = fileName;
 126   
         }        
 127  22092
         this.lineNumber = lineNumber;
 128  22092
         this.columnNumber = columnNumber;
 129   
     }
 130   
 
 131   
     /**
 132   
      * Returns the file name, line number, a colon and a trailing space. 
 133   
      * An error message can be appended easily. For unknown locations, an 
 134   
      * empty string is returned.
 135   
      * 
 136   
      * @return a String of the form <code>"fileName: lineNumber: "</code>
 137   
      *         if both file name and line number are known,
 138   
      *         <code>"fileName: "</code> if only the file name is known,
 139   
      *         and the empty string for unknown locations.
 140   
      */
 141  21
     public String toString() {
 142  21
         StringBuffer buf = new StringBuffer();
 143   
 
 144  21
         if (fileName != null) {
 145  18
             buf.append(fileName);
 146   
 
 147  18
             if (lineNumber != 0) {
 148  18
                 buf.append(":");
 149  18
                 buf.append(lineNumber);
 150   
             }
 151   
 
 152  18
             buf.append(": ");
 153   
         }
 154   
 
 155  21
         return buf.toString();
 156   
     }
 157   
 }
 158