jaxp/src/java.xml/share/classes/javax/xml/stream/Location.java
changeset 25868 686eef1e7a79
parent 12457 c348e06f0e82
child 42802 2a03abb03c06
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jaxp/src/java.xml/share/classes/javax/xml/stream/Location.java	Sun Aug 17 15:51:56 2014 +0100
@@ -0,0 +1,77 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
+ */
+
+package javax.xml.stream;
+
+/**
+ * Provides information on the location of an event.
+ *
+ * All the information provided by a Location is optional.  For example
+ * an application may only report line numbers.
+ *
+ * @version 1.0
+ * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
+ * @since 1.6
+ */
+public interface Location {
+  /**
+   * Return the line number where the current event ends,
+   * returns -1 if none is available.
+   * @return the current line number
+   */
+  int getLineNumber();
+
+  /**
+   * Return the column number where the current event ends,
+   * returns -1 if none is available.
+   * @return the current column number
+   */
+  int getColumnNumber();
+
+  /**
+   * Return the byte or character offset into the input source this location
+   * is pointing to. If the input source is a file or a byte stream then
+   * this is the byte offset into that stream, but if the input source is
+   * a character media then the offset is the character offset.
+   * Returns -1 if there is no offset available.
+   * @return the current offset
+   */
+  int getCharacterOffset();
+
+  /**
+   * Returns the public ID of the XML
+   * @return the public ID, or null if not available
+   */
+  public String getPublicId();
+
+  /**
+   * Returns the system ID of the XML
+   * @return the system ID, or null if not available
+   */
+  public String getSystemId();
+}