Attributes2
interface Attributes2 : Attributes
SAX2 extension to augment the per-attribute information provided though Attributes. If an implementation supports this extension, the attributes provided in ContentHandler.startElement() will implement this interface, and the http://xml.org/sax/features/use-attributes2 feature flag will have the value true. This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.
XMLReader implementations are not required to support this information, and it is not part of core-only SAX2 distributions.
Note that if an attribute was defaulted (!isSpecified()) it will of necessity also have been declared (isDeclared()) in the DTD. Similarly if an attribute's type is anything except CDATA, then it must have been declared.
Summary
| Public methods |
| abstract Boolean |
Returns false unless the attribute was declared in the DTD.
|
| abstract Boolean |
Returns false unless the attribute was declared in the DTD.
|
| abstract Boolean |
Returns false unless the attribute was declared in the DTD.
|
| abstract Boolean |
Returns true unless the attribute value was provided by DTD defaulting.
|
| abstract Boolean |
Returns true unless the attribute value was provided by DTD defaulting.
|
| abstract Boolean |
Returns true unless the attribute value was provided by DTD defaulting.
|
| Inherited functions |
From class Attributes
Int |
getIndex(uri: String!, localName: String!)
Look up the index of an attribute by Namespace name.
|
Int |
getIndex(qName: String!)
Look up the index of an attribute by XML qualified (prefixed) name.
|
Int |
getLength()
Return the number of attributes in the list.
Once you know the number of attributes, you can iterate through the list.
|
String! |
getLocalName(index: Int)
Look up an attribute's local name by index.
|
String! |
getQName(index: Int)
Look up an attribute's XML qualified (prefixed) name by index.
|
String! |
getType(index: Int)
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".
|
String! |
getType(uri: String!, localName: String!)
Look up an attribute's type by Namespace name.
See getType(int) for a description of the possible types.
|
String! |
getType(qName: String!)
Look up an attribute's type by XML qualified (prefixed) name.
See getType(int) for a description of the possible types.
|
String! |
getURI(index: Int)
Look up an attribute's Namespace URI by index.
|
String! |
getValue(index: Int)
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.
|
String! |
getValue(uri: String!, localName: String!)
Look up an attribute's value by Namespace name.
See getValue(int) for a description of the possible values.
|
String! |
getValue(qName: String!)
Look up an attribute's value by XML qualified (prefixed) name.
See getValue(int) for a description of the possible values.
|
|
Public methods
isDeclared
abstract fun isDeclared(index: Int): Boolean
Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).
| Parameters |
index |
Int: The attribute index (zero-based). |
| Return |
Boolean |
true if the attribute was declared in the DTD, false otherwise. |
| Exceptions |
java.lang.ArrayIndexOutOfBoundsException |
When the supplied index does not identify an attribute. |
isDeclared
abstract fun isDeclared(qName: String!): Boolean
Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).
| Parameters |
qName |
String!: The XML qualified (prefixed) name. |
| Return |
Boolean |
true if the attribute was declared in the DTD, false otherwise. |
| Exceptions |
java.lang.IllegalArgumentException |
When the supplied name does not identify an attribute. |
isDeclared
abstract fun isDeclared(
uri: String!,
localName: String!
): Boolean
Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).
Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.
| Parameters |
uri |
String!: The Namespace URI, or the empty string if the name has no Namespace URI. |
localName |
String!: The attribute's local name. |
| Return |
Boolean |
true if the attribute was declared in the DTD, false otherwise. |
| Exceptions |
java.lang.IllegalArgumentException |
When the supplied names do not identify an attribute. |
isSpecified
abstract fun isSpecified(index: Int): Boolean
Returns true unless the attribute value was provided by DTD defaulting.
| Parameters |
index |
Int: The attribute index (zero-based). |
| Return |
Boolean |
true if the value was found in the XML text, false if the value was provided by DTD defaulting. |
| Exceptions |
java.lang.ArrayIndexOutOfBoundsException |
When the supplied index does not identify an attribute. |
isSpecified
abstract fun isSpecified(
uri: String!,
localName: String!
): Boolean
Returns true unless the attribute value was provided by DTD defaulting.
Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.
| Parameters |
uri |
String!: The Namespace URI, or the empty string if the name has no Namespace URI. |
localName |
String!: The attribute's local name. |
| Return |
Boolean |
true if the value was found in the XML text, false if the value was provided by DTD defaulting. |
| Exceptions |
java.lang.IllegalArgumentException |
When the supplied names do not identify an attribute. |
isSpecified
abstract fun isSpecified(qName: String!): Boolean
Returns true unless the attribute value was provided by DTD defaulting.
| Parameters |
qName |
String!: The XML qualified (prefixed) name. |
| Return |
Boolean |
true if the value was found in the XML text, false if the value was provided by DTD defaulting. |
| Exceptions |
java.lang.IllegalArgumentException |
When the supplied name does not identify an attribute. |
