com.sun.xml.ws.streaming
Interface Attributes

All Known Implementing Classes:
XMLStreamReaderUtil.AttributesImpl

public interface Attributes

The Attributes interface is essentially a version of the org.xml.sax.Attributes interface modified to use the JAX-WS QName class.

Although namespace declarations can appear in the attribute list, the actual values of the local name and URI properties are implementation-specific.

Applications that need to iterate through all the attributes can use the isNamespaceDeclaration(int) method to identify namespace declarations and skip them.

Also, the URI property of an attribute will never be null. The value "" (empty string) is used for the URI of non-qualified attributes.


Method Summary
 int getIndex(javax.xml.namespace.QName name)
          Look up the index of an attribute by QName.
 int getIndex(java.lang.String localName)
          Look up the index of an attribute by local name.
 int getIndex(java.lang.String uri, java.lang.String localName)
          Look up the index of an attribute by URI and local name.
 int getLength()
          Return the number of attributes in the list.
 java.lang.String getLocalName(int index)
          Look up an attribute's local name by index.
 javax.xml.namespace.QName getName(int index)
          Look up an attribute's QName by index.
 java.lang.String getPrefix(int index)
          Look up an attribute's prefix by index.
 java.lang.String getURI(int index)
          Look up an attribute's URI by index.
 java.lang.String getValue(int index)
          Look up an attribute's value by index.
 java.lang.String getValue(javax.xml.namespace.QName name)
          Look up the value of an attribute by QName.
 java.lang.String getValue(java.lang.String localName)
          Look up the value of an attribute by local name.
 java.lang.String getValue(java.lang.String uri, java.lang.String localName)
          Look up the value of an attribute by URI and local name.
 boolean isNamespaceDeclaration(int index)
          Return true if the attribute at the given index is a namespace declaration.
 

Method Detail

getLength

int getLength()
Return the number of attributes in the list.


isNamespaceDeclaration

boolean isNamespaceDeclaration(int index)
Return true if the attribute at the given index is a namespace declaration.

Implementations are encouraged to optimize this method by taking into account their internal representations of attributes.


getName

javax.xml.namespace.QName getName(int index)
Look up an attribute's QName by index.


getURI

java.lang.String getURI(int index)
Look up an attribute's URI by index.


getLocalName

java.lang.String getLocalName(int index)
Look up an attribute's local name by index. If attribute is a namespace declaration, result is expected including "xmlns:".


getPrefix

java.lang.String getPrefix(int index)
Look up an attribute's prefix by index.


getValue

java.lang.String getValue(int index)
Look up an attribute's value by index.


getIndex

int getIndex(javax.xml.namespace.QName name)
Look up the index of an attribute by QName.


getIndex

int getIndex(java.lang.String uri,
             java.lang.String localName)
Look up the index of an attribute by URI and local name.


getIndex

int getIndex(java.lang.String localName)
Look up the index of an attribute by local name.


getValue

java.lang.String getValue(javax.xml.namespace.QName name)
Look up the value of an attribute by QName.


getValue

java.lang.String getValue(java.lang.String uri,
                          java.lang.String localName)
Look up the value of an attribute by URI and local name.


getValue

java.lang.String getValue(java.lang.String localName)
Look up the value of an attribute by local name.



Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.