content: /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
   * obtain a copy of the License at
   * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
   * or packager/legal/LICENSE.txt.  See the License for the specific
   * language governing permissions and limitations under the License.
   *
   * When distributing the software, include this License Header Notice in each
   * file and include the License file at packager/legal/LICENSE.txt.
   *
   * GPL Classpath Exception:
   * Oracle designates this particular file as subject to the "Classpath"
   * exception as provided by Oracle in the GPL Version 2 section of the License
   * file that accompanied this code.
   *
   * Modifications:
   * If applicable, add the following below the License Header, with the fields
   * enclosed by brackets [] replaced by your own identifying information:
   * "Portions Copyright [year] [name of copyright owner]"
   *
   * Contributor(s):
   * If you wish your version of this file to be governed by only the CDDL or
   * only the GPL Version 2, indicate your decision by adding "[Contributor]
   * elects to include this software in this distribution under the [CDDL or GPL
   * Version 2] license."  If you don't indicate a single choice of license, a
   * recipient has the option to distribute your version of this file under
   * either the CDDL, the GPL Version 2 or to extend the choice of license to
   * its licensees as provided above.  However, if you add GPL Version 2 code
   * and therefore, elected the GPL Version 2 license, then the option applies
   * only if the new code is made subject to such option by the copyright
   * holder.
   */
  
  /*
   * $Id: SourceLocator.java,v 1.5 2010-11-01 04:36:11 joehw Exp $
   * %W% %E%
   */
  package mf.javax.xml.transform;
  
  /**
   * This interface is primarily for the purposes of reporting where
   * an error occurred in the XML source or transformation instructions.
   */
  public interface SourceLocator {
  
      /**
       * Return the public identifier for the current document event.
       * <p/>
       * <p>The return value is the public identifier of the document
       * entity or of the external parsed entity in which the markup that
       * triggered the event appears.</p>
       *
       * @return A string containing the public identifier, or
       * null if none is available.
       * @see #getSystemId
       */
      String getPublicId();
  
      /**
       * Return the system identifier for the current document event.
       * <p/>
       * <p>The return value is the system identifier of the document
       * entity or of the external parsed entity in which the markup that
       * triggered the event appears.</p>
       * <p/>
       * <p>If the system identifier is a URL, the parser must resolve it
       * fully before passing it to the application.</p>
       *
       * @return A string containing the system identifier, or null
       * if none is available.
       * @see #getPublicId
       */
      String getSystemId();
  
      /**
       * Return the line number where the current document event ends.
       * <p/>
       * <p><strong>Warning:</strong> The return value from the method
       * is intended only as an approximation for the sake of error
       * reporting; it is not intended to provide sufficient information
       * to edit the character content of the original XML document.</p>
       * <p/>
       * <p>The return value is an approximation of the line number
       * in the document entity or external parsed entity where the
       * markup that triggered the event appears.</p>
       *
       * @return The line number, or -1 if none is available.
       * @see #getColumnNumber
       */
      int getLineNumber();
  
      /**
       * Return the character position where the current document event ends.
       * <p/>
       * <p><strong>Warning:</strong> The return value from the method
       * is intended only as an approximation for the sake of error
       * reporting; it is not intended to provide sufficient information
       * to edit the character content of the original XML document.</p>
       * <p/>
       * <p>The return value is an approximation of the column number
       * in the document entity or external parsed entity where the
       * markup that triggered the event appears.</p>
       *
       * @return The column number, or -1 if none is available.
       * @see #getLineNumber
       */
      int getColumnNumber();
  }
  