Interface Attributes

All Known Implementing Classes:
StAXReader.AttributesImpl, XmlTreeReader.AttributesAdapter

public interface Attributes

The Attributes interface is essentially a version of the org.xml.sax.Attributes interface modified to use the JAX-RPC 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.

Author:
JAX-RPC Development Team
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getIndex(String localName)
    Look up the index of an attribute by local name.
    int
    getIndex(String uri, String localName)
    Look up the index of an attribute by URI and local name.
    int
    Look up the index of an attribute by QName.
    int
    Return the number of attributes in the list.
    getLocalName(int index)
    Look up an attribute's local name by index.
    getName(int index)
    Look up an attribute's QName by index.
    getPrefix(int index)
    Look up an attribute's prefix by index.
    getURI(int index)
    Look up an attribute's URI by index.
    getValue(int index)
    Look up an attribute's value by index.
    getValue(String localName)
    Look up the value of an attribute by local name.
    getValue(String uri, String localName)
    Look up the value of an attribute by URI and local name.
    Look up the value of an attribute by QName.
    boolean
    Return true if the attribute at the given index is a namespace declaration.
  • Method Details

    • 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

      QName getName(int index)
      Look up an attribute's QName by index.
    • getURI

      String getURI(int index)
      Look up an attribute's URI by index.
    • getLocalName

      String getLocalName(int index)
      Look up an attribute's local name by index.
    • getPrefix

      String getPrefix(int index)
      Look up an attribute's prefix by index.
    • getValue

      String getValue(int index)
      Look up an attribute's value by index.
    • getIndex

      int getIndex(QName name)
      Look up the index of an attribute by QName.
    • getIndex

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

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

      String getValue(QName name)
      Look up the value of an attribute by QName.
    • getValue

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

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