/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2000,2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Xerces" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 1999, International
 * Business Machines, Inc., http://www.apache.org.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.xerces.xni;

/**
 * Extension to QName to allow absolute position of this QName in input entity.
 *
 * @author Stubs generated by DesignDoc on Wed Jun 07 11:58:44 PDT 2000
 * @author Andy Clark, IBM
 * @author Aleksander Slominski
 *
 * @version $Id:  $
 */
public class PositionedQName extends QName
{
    
    //
    // Data
    //
    
    /**
     * Absolute start position in current entity of the object associted with this QName
     */
    public int posAbsoluteStart;
    
    /**
     * Absolute end position in current entity of the object associted with this QName
     */
    public int posAbsoluteEnd;
    
    
    /** Default constructor. */
    public PositionedQName() {
        clear();
    } // <init>()
    
    //
    // Public methods
    //
    
    /**
     * Convenience method to set the values of the qname components.
     *
     * @param QName The qualified name to be copied.
     */
    public void setValues(QName qname) {
        prefix = qname.prefix;
        localpart = qname.localpart;
        rawname = qname.rawname;
        uri = qname.uri;
        if(qname instanceof PositionedQName) {
            PositionedQName pqname = (PositionedQName) qname;
            posAbsoluteStart  = pqname.posAbsoluteStart;
            posAbsoluteEnd  = pqname.posAbsoluteEnd;
        }
    } // setValues(QName)
    
    /** Clears the values of the qname components. */
    public void clear() {
        super.clear();
        posAbsoluteStart = -1;
        posAbsoluteEnd = -1;
    } // clear()
    
    //
    // Cloneable methods
    //
    
    /** Returns a clone of this object. */
    public Object clone() {
        PositionedQName pqname = new PositionedQName();
        pqname.setValues(this);
        return pqname;
    } // clone():Object
    
    //
    // Object methods
    //
    
    /** Returns a string representation of this object. */
    public String toString() {
        
        StringBuffer str = new StringBuffer();
        str.append("position start="+posAbsoluteStart+" end="+posAbsoluteEnd);
        boolean comma = true;
        if (prefix != null) {
            if (comma) {
                str.append(',');
            }
            str.append("prefix=\""+prefix+'"');
        }
        if (localpart != null) {
            if (comma) {
                str.append(',');
            }
            str.append("localpart=\""+localpart+'"');
            comma = true;
        }
        if (rawname != null) {
            if (comma) {
                str.append(',');
            }
            str.append("rawname=\""+rawname+'"');
            comma = true;
        }
        if (uri != null) {
            if (comma) {
                str.append(',');
            }
            str.append("uri=\""+uri+'"');
        }
        return str.toString();
        
    } // toString():String
    
} // class QName