Skip to content

Most visited

Recently visited

navigation

Attributes2

public interface Attributes2
implements Attributes

org.xml.sax.ext.Attributes2
Known Indirect Subclasses


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 isDeclared(String uri, String localName)

Returns false unless the attribute was declared in the DTD.

abstract boolean isDeclared(int index)

Returns false unless the attribute was declared in the DTD.

abstract boolean isDeclared(String qName)

Returns false unless the attribute was declared in the DTD.

abstract boolean isSpecified(String uri, String localName)

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

abstract boolean isSpecified(int index)

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

abstract boolean isSpecified(String qName)

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

Inherited methods

From interface org.xml.sax.Attributes

Public methods

isDeclared

Added in API level 1
boolean isDeclared (String uri, 
                String localName)

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.
Returns
boolean true if the attribute was declared in the DTD, false otherwise.
Throws
IllegalArgumentException When the supplied names do not identify an attribute.

isDeclared

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

isDeclared

Added in API level 1
boolean isDeclared (String qName)

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.
Returns
boolean true if the attribute was declared in the DTD, false otherwise.
Throws
IllegalArgumentException When the supplied name does not identify an attribute.

isSpecified

Added in API level 1
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 String: The Namespace URI, or the empty string if the name has no Namespace URI.
localName String: The attribute's local name.
Returns
boolean 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

Added in API level 1
boolean isSpecified (int index)

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

Parameters
index int: The attribute index (zero-based).
Returns
boolean 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

Added in API level 1
boolean isSpecified (String qName)

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

Parameters
qName String: The XML qualified (prefixed) name.
Returns
boolean 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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.