org.xml.sax.ext
Interface Attributes2

All Superinterfaces:
Attributes sample code for org.xml.sax.Attributes definition code for org.xml.sax.Attributes
All Known Implementing Classes:
Attributes2Impl sample code for org.xml.sax.ext.Attributes2Impl definition code for org.xml.sax.ext.Attributes2Impl

public interface Attributes2
extends Attributes sample code for org.xml.sax.Attributes definition code for org.xml.sax.Attributes

SAX2 extension to augment the per-attribute information provided though Attributes sample code for org.xml.sax.Attributes definition code for org.xml.sax.Attributes . If an implementation supports this extension, the attributes provided in ContentHandler.startElement() sample code for org.xml.sax.ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes) definition code for org.xml.sax.ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes) 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)

Method Summary
 boolean isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(int) definition code for org.xml.sax.ext.Attributes2.isDeclared(int) (int index)
          Returns false unless the attribute was declared in the DTD.
 boolean isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String) definition code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  qName)
          Returns false unless the attribute was declared in the DTD.
 boolean isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String, java.lang.String) definition code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  uri, String sample code for java.lang.String definition code for java.lang.String  localName)
          Returns false unless the attribute was declared in the DTD.
 boolean isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(int) definition code for org.xml.sax.ext.Attributes2.isSpecified(int) (int index)
          Returns true unless the attribute value was provided by DTD defaulting.
 boolean isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String) definition code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  qName)
          Returns true unless the attribute value was provided by DTD defaulting.
 boolean isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String, java.lang.String) definition code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  uri, String sample code for java.lang.String definition code for java.lang.String  localName)
          Returns true unless the attribute value was provided by DTD defaulting.
 
Methods inherited from interface org.xml.sax.Attributes sample code for org.xml.sax.Attributes definition code for org.xml.sax.Attributes
getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String) , getIndex sample code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getIndex(java.lang.String, java.lang.String) , getLength sample code for org.xml.sax.Attributes.getLength() definition code for org.xml.sax.Attributes.getLength() , getLocalName sample code for org.xml.sax.Attributes.getLocalName(int) definition code for org.xml.sax.Attributes.getLocalName(int) , getQName sample code for org.xml.sax.Attributes.getQName(int) definition code for org.xml.sax.Attributes.getQName(int) , getType sample code for org.xml.sax.Attributes.getType(int) definition code for org.xml.sax.Attributes.getType(int) , getType sample code for org.xml.sax.Attributes.getType(java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String) , getType sample code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getType(java.lang.String, java.lang.String) , getURI sample code for org.xml.sax.Attributes.getURI(int) definition code for org.xml.sax.Attributes.getURI(int) , getValue sample code for org.xml.sax.Attributes.getValue(int) definition code for org.xml.sax.Attributes.getValue(int) , getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String) , getValue sample code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String) definition code for org.xml.sax.Attributes.getValue(java.lang.String, java.lang.String)
 

Method Detail

isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(int) definition code for org.xml.sax.ext.Attributes2.isDeclared(int)

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 sample code for java.lang.ArrayIndexOutOfBoundsException definition code for java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String) definition code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String)

boolean isDeclared(String sample code for java.lang.String definition code for 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).

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

isDeclared sample code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String, java.lang.String) definition code for org.xml.sax.ext.Attributes2.isDeclared(java.lang.String, java.lang.String)

boolean isDeclared(String sample code for java.lang.String definition code for java.lang.String  uri,
                   String sample code for java.lang.String definition code for 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.

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(int) definition code for org.xml.sax.ext.Attributes2.isSpecified(int)

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 sample code for java.lang.ArrayIndexOutOfBoundsException definition code for java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String, java.lang.String) definition code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String, java.lang.String)

boolean isSpecified(String sample code for java.lang.String definition code for java.lang.String  uri,
                    String sample code for java.lang.String definition code for 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.

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified sample code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String) definition code for org.xml.sax.ext.Attributes2.isSpecified(java.lang.String)

boolean isSpecified(String sample code for java.lang.String definition code for java.lang.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - When the supplied name does not identify an attribute.