5b838d686f
git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226183 13f79535-47bb-0310-9956-ffa450edef68
90 lines
3.2 KiB
Java
90 lines
3.2 KiB
Java
/*
|
|
* Copyright 2003-2004 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
// $Id$
|
|
|
|
package 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>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
|
|
*/
|
|
public String getPublicId();
|
|
|
|
/**
|
|
* Return the system identifier for the current document event.
|
|
*
|
|
* <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>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
|
|
*/
|
|
public String getSystemId();
|
|
|
|
/**
|
|
* Return the line number where the current document event ends.
|
|
*
|
|
* <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>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
|
|
*/
|
|
public int getLineNumber();
|
|
|
|
/**
|
|
* Return the character position where the current document event ends.
|
|
*
|
|
* <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>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
|
|
*/
|
|
public int getColumnNumber();
|
|
}
|