Interface Attributes2

All Superinterfaces:: Attributes

All Known Implementing Classes:: Attributes2Impl

public interface Attributes2 extends Attributes

SAX2 extension to augment the per-attribute information provided through 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.

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.

Since:: 1.5, SAX 2.0 (extensions 1.1 alpha)

Method Summary

Modifier and Type	Method	Description
`boolean`	`isDeclared(int index)`	Returns false unless the attribute was declared in the DTD.
`boolean`	`isDeclared(String qName)`	Returns false unless the attribute was declared in the DTD.
`boolean`	`isDeclared(String uri, String localName)`	Returns false unless the attribute was declared in the DTD.
`boolean`	`isSpecified(int index)`	Returns true unless the attribute value was provided by DTD defaulting.
`boolean`	`isSpecified(String qName)`	Returns true unless the attribute value was provided by DTD defaulting.
`boolean`	`isSpecified(String uri, String localName)`	Returns true unless the attribute value was provided by DTD defaulting.

Methods declared in interface Attributes

getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue

Modifier and Type	Method	Description
`int`	`getIndex(String qName)`	Look up the index of an attribute by XML qualified (prefixed) name.
`int`	`getIndex(String uri, String localName)`	Look up the index of an attribute by Namespace name.
`int`	`getLength()`	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`	`getType(String qName)`	Look up an attribute's type by XML qualified (prefixed) name.
`String`	`getType(String uri, String localName)`	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`	`getValue(String qName)`	Look up an attribute's value by XML qualified (prefixed) name.
`String`	`getValue(String uri, String localName)`	Look up an attribute's value by Namespace name.

Method Details

isDeclared

boolean isDeclared(int index)

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 - The attribute index (zero-based).
Returns:: true if the attribute was declared in the DTD, false otherwise.
Throws:: ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isDeclared

boolean isDeclared(String qName)

Parameters:: qName - The XML qualified (prefixed) name.
Returns:: true if the attribute was declared in the DTD, false otherwise.
Throws:: IllegalArgumentException - When the supplied name does not identify an attribute.

isDeclared

boolean isDeclared(String uri, String localName)

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 - The Namespace URI, or the empty string if the name has no Namespace URI.; localName - The attribute's local name.
Returns:: true if the attribute was declared in the DTD, false otherwise.
Throws:: IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified

boolean isSpecified(int index)

Returns true unless the attribute value was provided by DTD defaulting.

Parameters:: index - The attribute index (zero-based).
Returns:: true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Throws:: ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isSpecified

boolean isSpecified(String uri, String localName)

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 - The Namespace URI, or the empty string if the name has no Namespace URI.; localName - The attribute's local name.
Returns:: true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Throws:: IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified

boolean isSpecified(String qName)

Returns true unless the attribute value was provided by DTD defaulting.

Parameters:: qName - The XML qualified (prefixed) name.
Returns:: true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Throws:: IllegalArgumentException - When the supplied name does not identify an attribute.

© 1993, 2025, 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.