com.sun.org.apache.xml.internal.utils.SAXSourceLocator Maven / Gradle / Ivy
Show all versions of jaxp-ri Show documentation
/*
* 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.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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: SAXSourceLocator.java,v 1.8 2010-11-01 04:34:52 joehw Exp $
*/
package com.sun.org.apache.xml.internal.utils;
import java.io.Serializable;
import javax.xml.transform.SourceLocator;
import org.xml.sax.Locator;
import org.xml.sax.SAXParseException;
import org.xml.sax.helpers.LocatorImpl;
/**
* Class SAXSourceLocator extends org.xml.sax.helpers.LocatorImpl
* for the purpose of implementing the SourceLocator interface,
* and thus can be both a SourceLocator and a SAX Locator.
*/
public class SAXSourceLocator extends LocatorImpl
implements SourceLocator, Serializable
{
static final long serialVersionUID = 3181680946321164112L;
/** The SAX Locator object.
* @serial
*/
Locator m_locator;
/**
* Constructor SAXSourceLocator
*
*/
public SAXSourceLocator(){}
/**
* Constructor SAXSourceLocator
*
*
* @param locator Source locator
*/
public SAXSourceLocator(Locator locator)
{
m_locator = locator;
this.setColumnNumber(locator.getColumnNumber());
this.setLineNumber(locator.getLineNumber());
this.setPublicId(locator.getPublicId());
this.setSystemId(locator.getSystemId());
}
/**
* Constructor SAXSourceLocator
*
*
* @param locator Source locator
*/
public SAXSourceLocator(javax.xml.transform.SourceLocator locator)
{
m_locator = null;
this.setColumnNumber(locator.getColumnNumber());
this.setLineNumber(locator.getLineNumber());
this.setPublicId(locator.getPublicId());
this.setSystemId(locator.getSystemId());
}
/**
* Constructor SAXSourceLocator
*
*
* @param spe SAXParseException exception.
*/
public SAXSourceLocator(SAXParseException spe)
{
this.setLineNumber( spe.getLineNumber() );
this.setColumnNumber( spe.getColumnNumber() );
this.setPublicId( spe.getPublicId() );
this.setSystemId( spe.getSystemId() );
}
/**
* Return the public identifier for the current document event.
*
* The return value is the public identifier of the document
* entity or of the external parsed entity in which the markup
* triggering the event appears.
*
* @return A string containing the public identifier, or
* null if none is available.
* @see #getSystemId
*/
public String getPublicId()
{
return (null == m_locator) ? super.getPublicId() : m_locator.getPublicId();
}
/**
* Return the system identifier for the current document event.
*
* The return value is the system identifier of the document
* entity or of the external parsed entity in which the markup
* triggering the event appears.
*
* If the system identifier is a URL, the parser must resolve it
* fully before passing it to the application.
*
* @return A string containing the system identifier, or null
* if none is available.
* @see #getPublicId
*/
public String getSystemId()
{
return (null == m_locator) ? super.getSystemId() : m_locator.getSystemId();
}
/**
* Return the line number where the current document event ends.
*
* Warning: 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.
*
* The return value is an approximation of the line number
* in the document entity or external parsed entity where the
* markup triggering the event appears.
*
* @return The line number, or -1 if none is available.
* @see #getColumnNumber
*/
public int getLineNumber()
{
return (null == m_locator) ? super.getLineNumber() : m_locator.getLineNumber();
}
/**
* Return the column number where the current document event ends.
*
* Warning: 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.
*
* The return value is an approximation of the column number
* in the document entity or external parsed entity where the
* markup triggering the event appears.
*
* @return The column number, or -1 if none is available.
* @see #getLineNumber
*/
public int getColumnNumber()
{
return (null == m_locator) ? super.getColumnNumber() : m_locator.getColumnNumber();
}
}