1 /* Location.java -- 2 Copyright (C) 2005 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath 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, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 package javax.xml.stream; 39 40 /** 41 * Information about the location of an XML event within the underlying 42 * stream. 43 */ 44 public interface Location 45 { 46 47 /** 48 * Returns the line number at which the current event ends, 49 * or -1 if this is not available. 50 */ getLineNumber()51 int getLineNumber(); 52 53 /** 54 * Returns the column number at which the current event ends, 55 * or -1 if this is not available. 56 */ getColumnNumber()57 int getColumnNumber(); 58 59 /** 60 * Returns the offset from the start of the source, in bytes or characters 61 * depending on the nature of the source, or -1 if this is not available. 62 */ getCharacterOffset()63 int getCharacterOffset(); 64 65 /** 66 * Returns the public identifier for this location, if any. 67 */ getPublicId()68 String getPublicId(); 69 70 /** 71 * Returns the system identifier for the underlying source. 72 */ getSystemId()73 String getSystemId(); 74 75 } 76