| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
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 {@link org.xml.sax.AttributeList 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.
Method Summary | |
---|---|
int |
Look up the index of an attribute by XML qualified (prefixed) name. |
int |
Look up the index of an attribute by Namespace name. |
int |
Return the number of attributes in the list. |
String |
getLocalName(int index) Look up an attribute's local name by index. |
String |
getQName(int index) Look up an attribute's XML qualified (prefixed) name by index. |
String |
getType(int index) Look up an attribute's type by index. |
String |
Look up an attribute's type by XML qualified (prefixed) name. |
String |
Look up an attribute's type by Namespace name. |
String |
getURI(int index) Look up an attribute's Namespace URI by index. |
String |
getValue(int index) Look up an attribute's value by index. |
String |
Look up an attribute's value by XML qualified (prefixed) name. |
String |
Look up an attribute's value by Namespace name. |
Method Detail |
---|
public int getIndex(String qName)
qName
- The qualified (prefixed) name.public int getIndex(String uri, String localName)
uri
- The Namespace URI, or the empty string if
the name has no Namespace URI.localName
- The attribute's local name.public int getLength()
Once you know the number of attributes, you can iterate through the list.
public String getLocalName(int index)
index
- The attribute index (zero-based).public String getQName(int index)
index
- The attribute index (zero-based).public String getType(int 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".
index
- The attribute index (zero-based).public String getType(String qName)
See {@link #getType(int) getType(int)} for a description of the possible types.
qName
- The XML qualified name.public String getType(String uri, String localName)
See {@link #getType(int) getType(int)} for a description of the possible types.
uri
- The Namespace URI, or the empty String if the
name has no Namespace URI.localName
- The local name of the attribute.public String getURI(int index)
index
- The attribute index (zero-based).public String getValue(int 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.
index
- The attribute index (zero-based).public String getValue(String qName)
See {@link #getValue(int) getValue(int)} for a description of the possible values.
qName
- The XML qualified name.public String getValue(String uri, String localName)
See {@link #getValue(int) getValue(int)} for a description of the possible values.
uri
- The Namespace URI, or the empty String if the
name has no Namespace URI.localName
- The local name of the attribute.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |