Attributes2 JDK 1.6)

Description

public interface Attributes2

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

See also:

Methods

Hide/Show inherited methods

public boolean isDeclared (int index)

Returns false unless the attribute was declared in the DTD.

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

public boolean isDeclared (String qName)

Returns false unless the attribute was declared in the DTD.

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).
Returns: true if the attribute was declared in the DTD, false otherwise.
Parameters:
- qName - The XML qualified (prefixed) name.
Throws:
- java.lang.IllegalArgumentException - When the supplied name does not identify an attribute.

public boolean isDeclared (String uri, String localName)

Returns false unless the attribute was declared in the DTD.

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

public boolean isSpecified (int index)

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

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

public boolean isSpecified (String qName)

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

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

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