Attributes2Impl

public class Attributes2Impl extends AttributesImpl
implements Attributes2

SAX2 extension helper for additional Attributes information, implementing the Attributes2 interface.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is not part of core-only SAX2 distributions.

The specified flag for each attribute will always be true, unless it has been set to false in the copy constructor or using setSpecified(int, boolean). Similarly, the declared flag for each attribute will always be false, except for defaulted attributes (specified is false), non-CDATA attributes, or when it is set to true using setDeclared(int, boolean). If you change an attribute's type by hand, you may need to modify its declared flag to match.

Public Constructor Summary

	Attributes2Impl() Construct a new, empty Attributes2Impl object.
	Attributes2Impl(Attributes atts) Copy an existing Attributes or Attributes2 object.

Public Method Summary

void	addAttribute(String uri, String localName, String qName, String type, String value) Add an attribute to the end of the list, setting its "specified" flag to true.
boolean	isDeclared(String uri, String localName) Returns false unless the attribute was declared in the DTD.
boolean	isDeclared(int index) Returns false unless the attribute was declared in the DTD.
boolean	isDeclared(String qName) Returns false unless the attribute was declared in the DTD.
boolean	isSpecified(String uri, String localName) Returns the current value of an attribute's "specified" flag.
boolean	isSpecified(int index) Returns the current value of an attribute's "specified" flag.
boolean	isSpecified(String qName) Returns the current value of an attribute's "specified" flag.
void	removeAttribute(int index) Remove an attribute from the list.
void	setAttributes(Attributes atts) Copy an entire Attributes object.
void	setDeclared(int index, boolean value) Assign a value to the "declared" flag of a specific attribute.
void	setSpecified(int index, boolean value) Assign a value to the "specified" flag of a specific attribute.

Inherited Method Summary

From class org.xml.sax.helpers.AttributesImpl

void	addAttribute(String uri, String localName, String qName, String type, String value) Add an attribute to the end of the list.
void	clear() Clear the attribute list for reuse.
int	getIndex(String qName) Look up an attribute's index by qualified (prefixed) name.
int	getIndex(String uri, String localName) Look up an attribute's index by Namespace name.
int	getLength() Return the number of attributes in the list.
String	getLocalName(int index) Return an attribute's local name.
String	getQName(int index) Return an attribute's qualified (prefixed) name.
String	getType(String qName) Look up an attribute's type by qualified (prefixed) name.
String	getType(int index) Return an attribute's type by index.
String	getType(String uri, String localName) Look up an attribute's type by Namespace-qualified name.
String	getURI(int index) Return an attribute's Namespace URI.
String	getValue(String qName) Look up an attribute's value by qualified (prefixed) name.
String	getValue(String uri, String localName) Look up an attribute's value by Namespace-qualified name.
String	getValue(int index) Return an attribute's value by index.
void	removeAttribute(int index) Remove an attribute from the list.
void	setAttribute(int index, String uri, String localName, String qName, String type, String value) Set an attribute in the list.
void	setAttributes(Attributes atts) Copy an entire Attributes object.
void	setLocalName(int index, String localName) Set the local name of a specific attribute.
void	setQName(int index, String qName) Set the qualified name of a specific attribute.
void	setType(int index, String type) Set the type of a specific attribute.
void	setURI(int index, String uri) Set the Namespace URI of a specific attribute.
void	setValue(int index, String value) Set the value of a specific attribute.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.Attributes

abstract int	getIndex(String qName) Look up the index of an attribute by XML qualified (prefixed) name.
abstract int	getIndex(String uri, String localName) Look up the index of an attribute by Namespace name.
abstract int	getLength() Return the number of attributes in the list.
abstract String	getLocalName(int index) Look up an attribute's local name by index.
abstract String	getQName(int index) Look up an attribute's XML qualified (prefixed) name by index.
abstract String	getType(String qName) Look up an attribute's type by XML qualified (prefixed) name.
abstract String	getType(int index) Look up an attribute's type by index.
abstract String	getType(String uri, String localName) Look up an attribute's type by Namespace name.
abstract String	getURI(int index) Look up an attribute's Namespace URI by index.
abstract String	getValue(String qName) Look up an attribute's value by XML qualified (prefixed) name.
abstract String	getValue(int index) Look up an attribute's value by index.
abstract String	getValue(String uri, String localName) Look up an attribute's value by Namespace name.

From interface org.xml.sax.ext.Attributes2

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.

Public Constructors

public Attributes2Impl ()

Construct a new, empty Attributes2Impl object.

public Attributes2Impl (Attributes atts)

Copy an existing Attributes or Attributes2 object. If the object implements Attributes2, values of the specified and declared flags for each attribute are copied. Otherwise the flag values are defaulted to assume no DTD was used, unless there is evidence to the contrary (such as attributes with type other than CDATA, which must have been declared).

This constructor is especially useful inside a startElement event.

Parameters

atts	The existing Attributes object.

Public Methods

public void addAttribute (String uri, String localName, String qName, String type, String value)

Add an attribute to the end of the list, setting its "specified" flag to true. To set that flag's value to false, use setSpecified(int, boolean).

Unless the attribute type is CDATA, this attribute is marked as being declared in the DTD. To set that flag's value to true for CDATA attributes, use setDeclared(int, boolean).

Parameters

uri	The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
localName	The local name, or the empty string if Namespace processing is not being performed.
qName	The qualified (prefixed) name, or the empty string if qualified names are not available.
type	The attribute type as a string.
value	The attribute value.

See Also

• AttributesImpl.addAttribute(String, String, String, String, String)

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	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.

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	The attribute index (zero-based).

Returns

• true if the attribute was declared in the DTD, false otherwise.

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	The XML qualified (prefixed) name.

Returns

• true if the attribute was declared in the DTD, false otherwise.

public boolean isSpecified (String uri, String localName)

Returns the current value of an attribute's "specified" flag.

Parameters

uri	The Namespace URI, or the empty string if the name has no Namespace URI.
localName	The attribute's local name.

Returns

• current flag value

Throws

IllegalArgumentException	When the supplied names do not identify an attribute.

public boolean isSpecified (int index)

Returns the current value of an attribute's "specified" flag.

Parameters

index	The attribute index (zero-based).

Returns

• current flag value

Throws

ArrayIndexOutOfBoundsException	When the supplied index does not identify an attribute.

public boolean isSpecified (String qName)

Returns the current value of an attribute's "specified" flag.

Parameters

qName	The XML qualified (prefixed) name.

Returns

• current flag value

Throws

IllegalArgumentException	When the supplied name does not identify an attribute.

public void removeAttribute (int index)

Remove an attribute from the list.

Parameters

index	The index of the attribute (zero-based).

public void setAttributes (Attributes atts)

Copy an entire Attributes object. The "specified" flags are assigned as true, and "declared" flags as false (except when an attribute's type is not CDATA), unless the object is an Attributes2 object. In that case those flag values are all copied.

Parameters

atts	The attributes to copy.

See Also

• AttributesImpl.setAttributes(Attributes)

public void setDeclared (int index, boolean value)

Assign a value to the "declared" flag of a specific attribute. This is normally needed only for attributes of type CDATA, including attributes whose type is changed to or from CDATA.

Parameters

index	The index of the attribute (zero-based).
value	The desired flag value.

Throws

ArrayIndexOutOfBoundsException	When the supplied index does not identify an attribute.

See Also

• AttributesImpl.setType(int, String)

public void setSpecified (int index, boolean value)

Assign a value to the "specified" flag of a specific attribute. This is the only way this flag can be cleared, except clearing by initialization with the copy constructor.

Parameters

index	The index of the attribute (zero-based).
value	The desired flag value.

Throws

ArrayIndexOutOfBoundsException	When the supplied index does not identify an attribute.