FileDocCategorySizeDatePackage
Attributes2.javaAPI DocJava SE 6 API5282Tue Jun 10 00:27:36 BST 2008org.xml.sax.ext

Attributes2

public interface Attributes2 implements Attributes
SAX2 extension to augment the per-attribute information provided though {@link Attributes}. If an implementation supports this extension, the attributes provided in {@link org.xml.sax.ContentHandler#startElement 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.

since
SAX 2.0 (extensions 1.1 alpha)
author
David Brownell
version
TBS

Fields Summary
Constructors Summary
Methods Summary
public booleanisDeclared(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).

param
index The attribute index (zero-based).
return
true if the attribute was declared in the DTD, false otherwise.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not identify an attribute.

public booleanisDeclared(java.lang.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).
param
qName The XML qualified (prefixed) name.
return
true if the attribute was declared in the DTD,
false otherwise.
exception
java.lang.IllegalArgumentException When the
supplied name does not identify an attribute.
public booleanisDeclared(java.lang.String uri, java.lang.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.
param
uri The Namespace URI, or the empty string if
the name has no Namespace URI.
param
localName The attribute's local name.
return
true if the attribute was declared in the DTD,
false otherwise.
exception
java.lang.IllegalArgumentException When the
supplied names do not identify an attribute.
public booleanisSpecified(int index)
Returns true unless the attribute value was provided
by DTD defaulting.
param
index The attribute index (zero-based).
return
true if the value was found in the XML text,
false if the value was provided by DTD defaulting.
exception
java.lang.ArrayIndexOutOfBoundsException When the
supplied index does not identify an attribute.
public booleanisSpecified(java.lang.String uri, java.lang.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.
param
uri The Namespace URI, or the empty string if
the name has no Namespace URI.
param
localName The attribute's local name.
return
true if the value was found in the XML text,
false if the value was provided by DTD defaulting.
exception
java.lang.IllegalArgumentException When the
supplied names do not identify an attribute.
public booleanisSpecified(java.lang.String qName)
Returns true unless the attribute value was provided
by DTD defaulting.
param
qName The XML qualified (prefixed) name.
return
true if the value was found in the XML text,
false if the value was provided by DTD defaulting.
exception
java.lang.IllegalArgumentException When the
supplied name does not identify an attribute.