org.xml.sax
Interface Attributes

All Known Subinterfaces:
Attributes2 sample code for org.xml.sax.ext.Attributes2 definition code for org.xml.sax.ext.Attributes2
All Known Implementing Classes:
Attributes2Impl sample code for org.xml.sax.ext.Attributes2Impl definition code for org.xml.sax.ext.Attributes2Impl , AttributesImpl sample code for org.xml.sax.helpers.AttributesImpl definition code for org.xml.sax.helpers.AttributesImpl

public interface 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 sample code for org.xml.sax.AttributeList definition code for org.xml.sax.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.

Since:
SAX 2.0
See Also:
AttributesImpl sample code for org.xml.sax.helpers.AttributesImpl definition code for org.xml.sax.helpers.AttributesImpl , DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) sample code for org.xml.sax.ext.DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) definition code for org.xml.sax.ext.DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Method Summary
 int getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  qName)
          Look up the index of an attribute by XML qualified (prefixed) name.
 int getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  uri, String sample code for java.lang.String definition code for java.lang.String  localName)
          Look up the index of an attribute by Namespace name.
 int getLength sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength() ()
          Return the number of attributes in the list.
 String sample code for java.lang.String definition code for java.lang.String getLocalName sample code for org.xml.sax.Attributes.getLocalName(int) definition code for org.xml.sax.Attributes.getLocalName(int) (int index)
          Look up an attribute's local name by index.
 String sample code for java.lang.String definition code for java.lang.String getQName sample code for org.xml.sax.Attributes.getQName(int) definition code for org.xml.sax.Attributes.getQName(int) (int index)
          Look up an attribute's XML qualified (prefixed) name by index.
 String sample code for java.lang.String definition code for java.lang.String getType sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int) (int index)
          Look up an attribute's type by index.
 String sample code for java.lang.String definition code for java.lang.String getType sample code for org.xml.sax.Attributes.getType(java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  qName)
          Look up an attribute's type by XML qualified (prefixed) name.
 String sample code for java.lang.String definition code for java.lang.String getType sample code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  uri, String sample code for java.lang.String definition code for java.lang.String  localName)
          Look up an attribute's type by Namespace name.
 String sample code for java.lang.String definition code for java.lang.String getURI sample code for org.xml.sax.Attributes.getURI(int) definition code for org.xml.sax.Attributes.getURI(int) (int index)
          Look up an attribute's Namespace URI by index.
 String sample code for java.lang.String definition code for java.lang.String getValue sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int) (int index)
          Look up an attribute's value by index.
 String sample code for java.lang.String definition code for java.lang.String getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  qName)
          Look up an attribute's value by XML qualified (prefixed) name.
 String sample code for java.lang.String definition code for java.lang.String getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  uri, String sample code for java.lang.String definition code for java.lang.String  localName)
          Look up an attribute's value by Namespace name.
 

Method Detail

getLength sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

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

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

Returns:
The number of attributes in the list.
See Also:
getURI(int) sample code for org.xml.sax.Attributes.getURI(int) definition code for org.xml.sax.Attributes.getURI(int) , getLocalName(int) sample code for org.xml.sax.Attributes.getLocalName(int) definition code for org.xml.sax.Attributes.getLocalName(int) , getQName(int) sample code for org.xml.sax.Attributes.getQName(int) definition code for org.xml.sax.Attributes.getQName(int) , getType(int) sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int) , getValue(int) sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int)

getURI sample code for org.xml.sax.Attributes.getURI(int) definition code for org.xml.sax.Attributes.getURI(int)

String sample code for java.lang.String definition code for java.lang.String  getURI(int index)
Look up an attribute's Namespace URI by index.

Parameters:
index - The attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.
See Also:
getLength() sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

getLocalName sample code for org.xml.sax.Attributes.getLocalName(int) definition code for org.xml.sax.Attributes.getLocalName(int)

String sample code for java.lang.String definition code for java.lang.String  getLocalName(int index)
Look up an attribute's local name by index.

Parameters:
index - The attribute index (zero-based).
Returns:
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:
getLength() sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

getQName sample code for org.xml.sax.Attributes.getQName(int) definition code for org.xml.sax.Attributes.getQName(int)

String sample code for java.lang.String definition code for java.lang.String  getQName(int index)
Look up an attribute's XML qualified (prefixed) name by index.

Parameters:
index - The attribute index (zero-based).
Returns:
The XML qualified name, or the empty string if none is available, or null if the index is out of range.
See Also:
getLength() sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

getType sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int)

String sample code for java.lang.String definition code for java.lang.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 - The attribute index (zero-based).
Returns:
The attribute's type as a string, or null if the index is out of range.
See Also:
getLength() sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

getValue sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int)

String sample code for java.lang.String definition code for java.lang.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 - The attribute index (zero-based).
Returns:
The attribute's value as a string, or null if the index is out of range.
See Also:
getLength() sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength()

getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String)

int getIndex(String sample code for java.lang.String definition code for java.lang.String  uri,
             String sample code for java.lang.String definition code for java.lang.String  localName)
Look up the index of an attribute by Namespace name.

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

getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String)

int getIndex(String sample code for java.lang.String definition code for java.lang.String  qName)
Look up the index of an attribute by XML qualified (prefixed) name.

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

getType sample code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getType(String sample code for java.lang.String definition code for java.lang.String  uri,
               String sample code for java.lang.String definition code for java.lang.String  localName)
Look up an attribute's type by Namespace name.

See getType(int) sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int) for a description of the possible types.

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

getType sample code for org.xml.sax.Attributes.getType(java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getType(String sample code for java.lang.String definition code for java.lang.String  qName)
Look up an attribute's type by XML qualified (prefixed) name.

See getType(int) sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int) for a description of the possible types.

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

getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getValue(String sample code for java.lang.String definition code for java.lang.String  uri,
                String sample code for java.lang.String definition code for java.lang.String  localName)
Look up an attribute's value by Namespace name.

See getValue(int) sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int) for a description of the possible values.

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

getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getValue(String sample code for java.lang.String definition code for java.lang.String  qName)
Look up an attribute's value by XML qualified (prefixed) name.

See getValue(int) sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int) for a description of the possible values.

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