Attributes2
Attributes2Impl
, AttributesImpl
public interface Attributes
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 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.
Modifier and Type | Method | Description |
---|---|---|
int |
getIndex |
Look up the index of an attribute by XML qualified (prefixed) name. |
int |
getIndex |
Look up the index of an attribute by Namespace name. |
int |
getLength() |
Return the number of attributes in the list. |
String |
getLocalName |
Look up an attribute's local name by index. |
String |
getQName |
Look up an attribute's XML qualified (prefixed) name by index. |
String |
getType |
Look up an attribute's type by index. |
String |
getType |
Look up an attribute's type by XML qualified (prefixed) name. |
String |
getType |
Look up an attribute's type by Namespace name. |
String |
getURI |
Look up an attribute's Namespace URI by index. |
String |
getValue |
Look up an attribute's value by index. |
String |
getValue |
Look up an attribute's value by XML qualified (prefixed) name. |
String |
getValue |
Look up an attribute's value by Namespace name. |
int getLength()
Once you know the number of attributes, you can iterate through the list.
String getURI(int index)
index
- The attribute index (zero-based).String getLocalName(int index)
index
- The attribute index (zero-based).String getQName(int index)
index
- The attribute index (zero-based).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).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).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.int getIndex(String qName)
qName
- The qualified (prefixed) name.String getType(String uri, String localName)
See 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.String getType(String qName)
See getType(int)
for a description of the possible types.
qName
- The XML qualified name.String getValue(String uri, String localName)
See 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.String getValue(String qName)
See getValue(int)
for a description of the possible values.
qName
- The XML qualified name.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/xml/sax/Attributes.html