aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.runtime.unmarshaller;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.Name;
aoqi@0: 
aoqi@0: import org.xml.sax.Attributes;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Represents an XML tag name (and attributes for start tags.)
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This object is used so reduce the number of method call parameters
aoqi@0:  * among unmarshallers.
aoqi@0:  *
aoqi@0:  * An instance of this is expected to be reused by the caller of
aoqi@0:  * {@link XmlVisitor}. Note that the rest of the unmarshaller may
aoqi@0:  * modify any of the fields while processing an event (such as to
aoqi@0:  * intern strings, replace attributes),
aoqi@0:  * so {@link XmlVisitor} should reset all fields for each use.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * The 'qname' parameter, which holds the qualified name of the tag
aoqi@0:  * (such as 'foo:bar' or 'zot'), is not used in the typical unmarshalling
aoqi@0:  * route and it's also expensive to compute for some input.
aoqi@0:  * Thus this parameter is computed lazily.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: @SuppressWarnings({"StringEquality"})
aoqi@0: public abstract class TagName {
aoqi@0:     /**
aoqi@0:      * URI of the attribute/element name.
aoqi@0:      *
aoqi@0:      * Can be empty, but never null. Interned.
aoqi@0:      */
aoqi@0:     public String uri;
aoqi@0:     /**
aoqi@0:      * Local part of the attribute/element name.
aoqi@0:      *
aoqi@0:      * Never be null. Interned.
aoqi@0:      */
aoqi@0:     public String local;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Used only for the enterElement event.
aoqi@0:      * Otherwise the value is undefined.
aoqi@0:      *
aoqi@0:      * This might be {@link AttributesEx}.
aoqi@0:      */
aoqi@0:     public Attributes atts;
aoqi@0: 
aoqi@0:     public TagName() {
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the given name pair matches this name.
aoqi@0:      */
aoqi@0:     public final boolean matches( String nsUri, String local ) {
aoqi@0:         return this.uri==nsUri && this.local==local;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the given name pair matches this name.
aoqi@0:      */
aoqi@0:     public final boolean matches( Name name ) {
aoqi@0:         return this.local==name.localName && this.uri==name.nsUri;
aoqi@0:     }
aoqi@0: 
aoqi@0: //    /**
aoqi@0: //     * @return
aoqi@0: //     *      Can be empty but always non-null. NOT interned.
aoqi@0: //     */
aoqi@0: //    public final String getPrefix() {
aoqi@0: //        int idx = qname.indexOf(':');
aoqi@0: //        if(idx<0)   return "";
aoqi@0: //        else        return qname.substring(0,idx);
aoqi@0: //    }
aoqi@0: 
aoqi@0:     public String toString() {
aoqi@0:         return '{'+uri+'}'+local;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the qualified name of the tag.
aoqi@0:      *
aoqi@0:      * @return never null.
aoqi@0:      */
aoqi@0:     public abstract String getQname();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the prefix. This is slow.
aoqi@0:      *
aoqi@0:      * @return can be "" but never null.
aoqi@0:      */
aoqi@0:     public String getPrefix() {
aoqi@0:         String qname = getQname();
aoqi@0:         int idx = qname.indexOf(':');
aoqi@0:         if(idx<0)   return "";
aoqi@0:         else        return qname.substring(0,idx);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates {@link QName}.
aoqi@0:      */
aoqi@0:     public QName createQName() {
aoqi@0:         return new QName(uri,local,getPrefix());
aoqi@0:     }
aoqi@0: }