Added in API level 1
Summary: Methods

Attributes

public interface Attributes

org.xml.sax.Attributes

Interface for a list of XML attributes.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This interface allows access to a list of attributes in three different ways:

  1. by attribute index;
  2. by Namespace-qualified name; or
  3. by qualified (prefixed) name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default). Because SAX2 conforms to the original "Namespaces in XML" recommendation, it normally does not give namespace declaration attributes a namespace URI.

Some SAX2 parsers may support using an optional feature flag (http://xml.org/sax/features/xmlns-uris) to request that those attributes be given URIs, conforming to a later backwards-incompatible revision of that recommendation. (The attribute's "local name" will be the prefix, or "xmlns" when defining a default element namespace.) For portability, handler code should always resolve that conflict, rather than requiring parsers that can change the setting of that feature flag.

If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the http://xml.org/sax/features/namespaces feature is false, access by Namespace-qualified names may not be available.

This interface replaces the now-deprecated SAX1 AttributeList interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below).

The order of attributes in the list is unspecified, and will vary from implementation to implementation.

Summary

Public methods

abstract int getIndex(String qName)

Look up the index of an attribute by XML qualified (prefixed) name.

abstract int getIndex(String uri, String localName)

Look up the index of an attribute by Namespace name.

abstract int getLength()

Return the number of attributes in the list.

abstract String getLocalName(int index)

Look up an attribute's local name by index.

abstract String getQName(int index)

Look up an attribute's XML qualified (prefixed) name by index.

abstract String getType(String qName)

Look up an attribute's type by XML qualified (prefixed) name.

abstract String getType(int index)

Look up an attribute's type by index.

abstract String getType(String uri, String localName)

Look up an attribute's type by Namespace name.

abstract String getURI(int index)

Look up an attribute's Namespace URI by index.

abstract String getValue(String qName)

Look up an attribute's value by XML qualified (prefixed) name.

abstract String getValue(int index)

Look up an attribute's value by index.

abstract String getValue(String uri, String localName)

Look up an attribute's value by Namespace name.

Public methods

getIndex

Added in API level 1 
public abstract int getIndex (String qName)

Look up the index of an attribute by XML qualified (prefixed) name.

Parameters
qName String: The qualified (prefixed) name.
Returns
int The index of the attribute, or -1 if it does not appear in the list.

getIndex

Added in API level 1 
public abstract int getIndex (String uri, 
                String localName)

Look up the index of an attribute by Namespace name.

Parameters
uri String: The Namespace URI, or the empty string if the name has no Namespace URI.
localName String: The attribute's local name.
Returns
int The index of the attribute, or -1 if it does not appear in the list.

getLength

Added in API level 1 
public abstract int getLength ()

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns
int The number of attributes in the list.

getLocalName

Added in API level 1 
public abstract String getLocalName (int index)

Look up an attribute's local name by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.

See also:

getQName

Added in API level 1 
public abstract String getQName (int index)

Look up an attribute's XML qualified (prefixed) name by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The XML qualified name, or the empty string if none is available, or null if the index is out of range.

See also:

getType

Added in API level 1 
public abstract String getType (String qName)

Look up an attribute's type by XML qualified (prefixed) name.

See getType(int) for a description of the possible types.

Parameters
qName String: The XML qualified name.
Returns
String The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

getType

Added in API level 1 
public abstract String getType (int index)

Look up an attribute's type by index.

The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case).

If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Parameters
index int: The attribute index (zero-based).
Returns
String The attribute's type as a string, or null if the index is out of range.

See also:

getType

Added in API level 1 
public abstract String getType (String uri, 
                String localName)

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Parameters
uri String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName String: The local name of the attribute.
Returns
String The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.

getURI

Added in API level 1 
public abstract String getURI (int index)

Look up an attribute's Namespace URI by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The Namespace URI, or the empty string if none is available, or null if the index is out of range.

See also:

getValue

Added in API level 1 
public abstract String getValue (String qName)

Look up an attribute's value by XML qualified (prefixed) name.

See getValue(int) for a description of the possible values.

Parameters
qName String: The XML qualified name.
Returns
String The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

getValue

Added in API level 1 
public abstract String getValue (int index)

Look up an attribute's value by index.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters
index int: The attribute index (zero-based).
Returns
String The attribute's value as a string, or null if the index is out of range.

See also:

getValue

Added in API level 1 
public abstract String getValue (String uri, 
                String localName)

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Parameters
uri String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName String: The local name of the attribute.
Returns
String The attribute value as a string, or null if the attribute is not in the list.