This module, both source code and documentation, is in the
Public Domain, and comes with NO WARRANTY.
This interface allows access to a list of attributes in
three different ways:
by attribute index;
by Namespace-qualified name; or
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
feature is set to true (it is false by
default).
If the namespace-prefixes feature (see above) is false,
access by qualified name may not be available; if the
feature is false, access by Namespace-qualified names
may not be available.
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
Version:
2.0
Method Summary
int
Look up the index of an attribute by XML 1.0 qualified name.
int
java.lang.String localPart)
Look up the index of an attribute by Namespace name.
int
Return the number of attributes in the list.
java.lang.String
Look up an attribute's local name by index.
java.lang.String
Look up an attribute's XML 1.0 qualified name by index.
java.lang.String
Look up an attribute's type by index.
java.lang.String
Look up an attribute's type by XML 1.0 qualified name.
java.lang.String
java.lang.String localName)
Look up an attribute's type by Namespace name.
java.lang.String
Look up an attribute's Namespace URI by index.
java.lang.String
Look up an attribute's value by index.
java.lang.String
Look up an attribute's value by XML 1.0 qualified name.
java.lang.String
java.lang.String localName)
Look up an attribute's value by Namespace name.
Method Detail
getLength
public int getLength()
Return the number of attributes in the list.
Once you know the number of attributes, you can iterate
through the list.
getURI
public 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
getLocalName
public 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
getQName
public java.lang.String getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
Parameters:
index - The attribute index (zero-based).
Returns:
The XML 1.0 qualified name, or the empty string
if none is available, or null if the index
getType
public 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 Recommentation
(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
getValue
public 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
getIndex
public int getIndex(java.lang.String uri,
java.lang.String localPart)
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
public int getIndex(java.lang.String qName)
Look up the index of an attribute by XML 1.0 qualified name.
Parameters:
qName - The qualified (prefixed) name.
Returns:
The index of the attribute, or -1 if it does not
appear in the list.
getType
public java.lang.String getType(java.lang.String uri,
java.lang.String localName)
Look up an attribute's type by Namespace name.
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
public java.lang.String getType(java.lang.String qName)
Look up an attribute's type by XML 1.0 qualified name.
of the possible types.
Parameters:
qName - The XML 1.0 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
public java.lang.String getValue(java.lang.String uri,
java.lang.String localName)
Look up an attribute's value by Namespace name.
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
public java.lang.String getValue(java.lang.String qName)
Look up an attribute's value by XML 1.0 qualified name.
of the possible values.
Parameters:
qName - The XML 1.0 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.