org.ccil.cowan.tagsoup
public class AttributesImpl extends Object implements Attributes
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.
This class provides a default implementation of the SAX2
org.xml.sax.Attributes Attributes
interface, with the
addition of manipulators so that the list can be modified or
reused.
There are two typical uses of this class:
org.xml.sax.ContentHandler#startElement startElement
event; orThis class replaces the now-deprecated SAX1 org.xml.sax.helpers.AttributeListImpl AttributeListImpl
class; in addition to supporting the updated Attributes
interface rather than the deprecated org.xml.sax.AttributeList
AttributeList
interface, it also includes a much more efficient
implementation using a single array rather than a set of Vectors.
Since: SAX 2.0
Version: 2.0.1 (sax2r2)
Constructor Summary | |
---|---|
AttributesImpl()
Construct a new, empty AttributesImpl object. | |
AttributesImpl(Attributes atts)
Copy an existing Attributes object.
|
Method Summary | |
---|---|
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 uri, String localName)
Look up an attribute's index by Namespace name.
|
int | getIndex(String qName)
Look up an attribute's index by qualified (prefixed) 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(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 | getType(String qName)
Look up an attribute's type by qualified (prefixed) name.
|
String | getURI(int index)
Return an attribute's Namespace URI.
|
String | getValue(int index)
Return an attribute's value by index.
|
String | getValue(String uri, String localName)
Look up an attribute's value by Namespace-qualified name.
|
String | getValue(String qName)
Look up an attribute's value by qualified (prefixed) name.
|
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.
|
This constructor is especially useful inside a
org.xml.sax.ContentHandler#startElement startElement
event.
Parameters: atts The existing Attributes object.
For the sake of speed, this method does no checking to see if the attribute is already in the list: that is the responsibility of the application.
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.
Note that little memory is freed by this call: the current array is kept so it can be reused.
In many cases, it will be more efficient to look up the name once and use the index query methods rather than using the name query methods repeatedly.
Parameters: uri The attribute's Namespace URI, or the empty string if none is available. localName The attribute's local name.
Returns: The attribute's index, or -1 if none matches.
See Also: org.xml.sax.Attributes#getIndex(java.lang.String,java.lang.String)
Parameters: qName The qualified name.
Returns: The attribute's index, or -1 if none matches.
See Also: org.xml.sax.Attributes#getIndex(java.lang.String)
Returns: The number of attributes in the list.
See Also: org.xml.sax.Attributes#getLength
Parameters: index The attribute's index (zero-based).
Returns: The attribute's local name, the empty string if none is available, or null if the index if out of range.
See Also: org.xml.sax.Attributes#getLocalName
Parameters: index The attribute's index (zero-based).
Returns: The attribute's qualified name, the empty string if none is available, or null if the index is out of bounds.
See Also: org.xml.sax.Attributes#getQName
Parameters: index The attribute's index (zero-based).
Returns: The attribute's type, "CDATA" if the type is unknown, or null if the index is out of bounds.
See Also: org.xml.sax.Attributes#getType(int)
Parameters: uri The Namespace URI, or the empty string for a name with no explicit Namespace URI. localName The local name.
Returns: The attribute's type, or null if there is no matching attribute.
See Also: org.xml.sax.Attributes#getType(java.lang.String,java.lang.String)
Parameters: qName The qualified name.
Returns: The attribute's type, or null if there is no matching attribute.
See Also: org.xml.sax.Attributes#getType(java.lang.String)
Parameters: index The attribute's index (zero-based).
Returns: The Namespace URI, the empty string if none is available, or null if the index is out of range.
See Also: org.xml.sax.Attributes#getURI
Parameters: index The attribute's index (zero-based).
Returns: The attribute's value or null if the index is out of bounds.
See Also: org.xml.sax.Attributes#getValue(int)
Parameters: uri The Namespace URI, or the empty string for a name with no explicit Namespace URI. localName The local name.
Returns: The attribute's value, or null if there is no matching attribute.
See Also: org.xml.sax.Attributes#getValue(java.lang.String,java.lang.String)
Parameters: qName The qualified name.
Returns: The attribute's value, or null if there is no matching attribute.
See Also: org.xml.sax.Attributes#getValue(java.lang.String)
Parameters: index The index of the attribute (zero-based).
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
For the sake of speed, this method does no checking for name conflicts or well-formedness: such checks are the responsibility of the application.
Parameters: index The index of the attribute (zero-based). 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 name, or the empty string if qualified names are not available. type The attribute type as a string. value The attribute value.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
It may be more efficient to reuse an existing object rather than constantly allocating new ones.
Parameters: atts The attributes to copy.
Parameters: index The index of the attribute (zero-based). localName The attribute's local name, or the empty string for none.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
Parameters: index The index of the attribute (zero-based). qName The attribute's qualified name, or the empty string for none.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
Parameters: index The index of the attribute (zero-based). type The attribute's type.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
Parameters: index The index of the attribute (zero-based). uri The attribute's Namespace URI, or the empty string for none.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.
Parameters: index The index of the attribute (zero-based). value The attribute's value.
Throws: java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.