aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, 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.ws.streaming;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * <p> The Attributes interface is essentially a version of the
aoqi@0:  * org.xml.sax.Attributes interface modified to use the JAX-WS QName class.</p>
aoqi@0:  *
aoqi@0:  * <p> Although namespace declarations can appear in the attribute list, the
aoqi@0:  * actual values of the local name and URI properties are
aoqi@0:  * implementation-specific. </p>
aoqi@0:  *
aoqi@0:  * <p> Applications that need to iterate through all the attributes can use the
aoqi@0:  * {@link #isNamespaceDeclaration} method to identify namespace declarations
aoqi@0:  * and skip them. </p>
aoqi@0:  *
aoqi@0:  * <p> Also, the URI property of an attribute will never be null. The value
aoqi@0:  * "" (empty string) is used for the URI of non-qualified attributes. </p>
aoqi@0:  *
aoqi@0:  * @author WS Development Team
aoqi@0:  */
aoqi@0: public interface Attributes {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the number of attributes in the list.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public int getLength();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if the attribute at the given index is a namespace
aoqi@0:      * declaration.
aoqi@0:      *
aoqi@0:      * <p> Implementations are encouraged to optimize this method by taking into
aoqi@0:      * account their internal representations of attributes. </p>
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public boolean isNamespaceDeclaration(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up an attribute's QName by index.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public QName getName(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up an attribute's URI by index.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getURI(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up an attribute's local name by index.
aoqi@0:      * If attribute is a namespace declaration, result
aoqi@0:      * is expected including "xmlns:".
aoqi@0:      */
aoqi@0:     public String getLocalName(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up an attribute's prefix by index.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getPrefix(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up an attribute's value by index.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getValue(int index);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the index of an attribute by QName.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public int getIndex(QName name);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the index of an attribute by URI and local name.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public int getIndex(String uri, String localName);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the index of an attribute by local name.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public int getIndex(String localName);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the value of an attribute by QName.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getValue(QName name);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the value of an attribute by URI and local name.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getValue(String uri, String localName);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Look up the value of an attribute by local name.
aoqi@0:      *
aoqi@0:      */
aoqi@0:     public String getValue(String localName);
aoqi@0: }