Top Description Methods
org.xml.sax.ext

public Interface Attributes2

extends Attributes
Known Direct Implementers
org.xml.sax.ext.Attributes2Impl, com.sun.org.apache.xerces.internal.parsers.AbstractSAXParser.AttributesProxy, com.sun.org.apache.xerces.internal.util.AttributesProxy
Imports
org.xml.sax.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.

Author
David Brownell
Since
1.5, SAX 2.0 (extensions 1.1 alpha)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the attribute was declared in the DTD, false otherwise.
isDeclared
(int
The attribute index (zero-based).
index
)

Returns false unless the attribute was declared in the DTD.

public boolean

Returns:

true if the attribute was declared in the DTD, false otherwise.
isDeclared
(String
The XML qualified (prefixed) name.
qName
)

Returns false unless the attribute was declared in the DTD.

public boolean

Returns:

true if the attribute was declared in the DTD, false otherwise.
isDeclared
(String
The Namespace URI, or the empty string if the name has no Namespace URI.
uri
,
String
The attribute's local name.
localName
)

Returns false unless the attribute was declared in the DTD.

public boolean

Returns:

true if the value was found in the XML text, false if the value was provided by DTD defaulting.
isSpecified
(int
The attribute index (zero-based).
index
)

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

public boolean

Returns:

true if the value was found in the XML text, false if the value was provided by DTD defaulting.
isSpecified
(String
The Namespace URI, or the empty string if the name has no Namespace URI.
uri
,
String
The attribute's local name.
localName
)

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

public boolean

Returns:

true if the value was found in the XML text, false if the value was provided by DTD defaulting.
isSpecified
(String
The XML qualified (prefixed) name.
qName
)

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

Inherited from org.xml.sax.Attributes:
getIndexgetIndexgetLengthgetLocalNamegetQNamegetTypegetTypegetTypegetURIgetValuegetValuegetValue

Method Detail

isDeclaredback to summary
public 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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not identify an attribute.
isDeclaredback to summary
public 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.

Exceptions
IllegalArgumentException:
When the supplied name does not identify an attribute.
isDeclaredback to summary
public 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.

Exceptions
IllegalArgumentException:
When the supplied names do not identify an attribute.
isSpecifiedback to summary
public 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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not identify an attribute.
isSpecifiedback to summary
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.

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.

Exceptions
IllegalArgumentException:
When the supplied names do not identify an attribute.
isSpecifiedback to summary
public 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.

Exceptions
IllegalArgumentException:
When the supplied name does not identify an attribute.