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;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The internal representation of an XML name.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This class keeps indicies for URI and local name for enabling faster processing.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * {@link Name}s are ordered lexicographically (nsUri first, local name next.)
aoqi@0:  * This is the same order required by canonical XML.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public final class Name implements Comparable<Name> {
aoqi@0:     /**
aoqi@0:      * Namespace URI. interned.
aoqi@0:      */
aoqi@0:     public final String nsUri;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Local name. interned.
aoqi@0:      */
aoqi@0:     public final String localName;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Index -1 is reserved for representing the empty namespace URI of attributes.
aoqi@0:      */
aoqi@0:     public final short nsUriIndex;
aoqi@0:     public final short localNameIndex;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Index of the Name for an EII or AII
aoqi@0:      */
aoqi@0:     public final short qNameIndex;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Specifies if the Name is associated with an EII or AII
aoqi@0:      */
aoqi@0:     public final boolean isAttribute;
aoqi@0: 
aoqi@0:     Name(int qNameIndex, int nsUriIndex, String nsUri, int localIndex, String localName, boolean isAttribute) {
aoqi@0:         this.qNameIndex = (short)qNameIndex;
aoqi@0:         this.nsUri = nsUri;
aoqi@0:         this.localName = localName;
aoqi@0:         this.nsUriIndex = (short)nsUriIndex;
aoqi@0:         this.localNameIndex = (short)localIndex;
aoqi@0:         this.isAttribute = isAttribute;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String toString() {
aoqi@0:         return '{'+nsUri+'}'+localName;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a {@link QName} from this.
aoqi@0:      */
aoqi@0:     public QName toQName() {
aoqi@0:         return new QName(nsUri,localName);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean equals( String nsUri, String localName ) {
aoqi@0:         return localName.equals(this.localName) && nsUri.equals(this.nsUri);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public int compareTo(Name that) {
aoqi@0:         int r = this.nsUri.compareTo(that.nsUri);
aoqi@0:         if(r!=0)    return r;
aoqi@0:         return this.localName.compareTo(that.localName);
aoqi@0:     }
aoqi@0: }