| java.lang.Object
 org.xml.sax.helpers.AttributesImpl
All known Subclasses: org.xml.sax.ext.Attributes2Impl,
| AttributesImpl | | public class AttributesImpl implements Attributes(Code) | | Default implementation of the Attributes interface.
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:
- to take a persistent snapshot of an Attributes object
in a
org.xml.sax.ContentHandler.startElement startElement event; or
- to construct or modify an Attributes object in a SAX2 driver or filter.
This 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.AttributeListAttributeList interface, it also includes a much more efficient
implementation using a single array rather than a set of Vectors.
since:
SAX 2.0
author:
David Megginson
version:
2.0.1 (sax2r2) |
| Method Summary | |
| public void | addAttribute(String uri, String localName, String qName, String type, String value)
Add an attribute to the end of the list. | | public void | clear()
Clear the attribute list for reuse. | | public int | getIndex(String uri, String localName)
Look up an attribute's index by Namespace name.
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 emptystring if none is available.
Parameters:
localName - The attribute's local name. | | public int | getIndex(String qName)
Look up an attribute's index by qualified (prefixed) name.
Parameters:
qName - The qualified name. | | public int | getLength()
Return the number of attributes in the list. | | public String | getLocalName(int index)
Return an attribute's local name.
Parameters:
index - The attribute's index (zero-based). | | public String | getQName(int index)
Return an attribute's qualified (prefixed) name.
Parameters:
index - The attribute's index (zero-based). | | public String | getType(int index)
Return an attribute's type by index.
Parameters:
index - The attribute's index (zero-based). | | public String | getType(String uri, String localName)
Look up an attribute's type by Namespace-qualified name.
Parameters:
uri - The Namespace URI, or the empty string for a namewith no explicit Namespace URI.
Parameters:
localName - The local name. | | public String | getType(String qName)
Look up an attribute's type by qualified (prefixed) name.
Parameters:
qName - The qualified name. | | public String | getURI(int index)
Return an attribute's Namespace URI.
Parameters:
index - The attribute's index (zero-based). | | public String | getValue(int index)
Return an attribute's value by index.
Parameters:
index - The attribute's index (zero-based). | | public String | getValue(String uri, String localName)
Look up an attribute's value by Namespace-qualified name.
Parameters:
uri - The Namespace URI, or the empty string for a namewith no explicit Namespace URI.
Parameters:
localName - The local name. | | public String | getValue(String qName)
Look up an attribute's value by qualified (prefixed) name.
Parameters:
qName - The qualified name. | | public void | removeAttribute(int index)
Remove an attribute from the list. | | public void | setAttribute(int index, String uri, String localName, String qName, String type, String value)
Set an attribute in the list. | | public void | setAttributes(Attributes atts)
Copy an entire Attributes object. | | public void | setLocalName(int index, String localName)
Set the local name of a specific attribute. | | public void | setQName(int index, String qName)
Set the qualified name of a specific attribute. | | public void | setType(int index, String type)
Set the type of a specific attribute. | | public void | setURI(int index, String uri)
Set the Namespace URI of a specific attribute. | | public void | setValue(int index, String value)
Set the value of a specific attribute. |
| AttributesImpl | | public AttributesImpl()(Code) | | Construct a new, empty AttributesImpl object.
|
| addAttribute | | public void addAttribute(String uri, String localName, String qName, String type, String value)(Code) | | Add an attribute to the end of the list.
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 ifnone is available or Namespace processing is notbeing performed.
Parameters:
localName - The local name, or the empty string ifNamespace processing is not being performed.
Parameters:
qName - The qualified (prefixed) name, or the empty stringif qualified names are not available.
Parameters:
type - The attribute type as a string.
Parameters:
value - The attribute value. |
| clear | | public void clear()(Code) | | Clear the attribute list for reuse.
Note that little memory is freed by this call:
the current array is kept so it can be
reused.
|
| getIndex | | public int getIndex(String uri, String localName)(Code) | | Look up an attribute's index by Namespace name.
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 emptystring if none is available.
Parameters:
localName - The attribute's local name. The attribute's index, or -1 if none matches.
See Also: org.xml.sax.Attributes.getIndex(java.lang.Stringjava.lang.String) |
| getLocalName | | public String getLocalName(int index)(Code) | | Return an attribute's local name.
Parameters:
index - The attribute's index (zero-based). 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 |
| getQName | | public String getQName(int index)(Code) | | Return an attribute's qualified (prefixed) name.
Parameters:
index - The attribute's index (zero-based). 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 |
| getType | | public String getType(int index)(Code) | | Return an attribute's type by index.
Parameters:
index - The attribute's index (zero-based). The attribute's type, "CDATA" if the type is unknown, or nullif the index is out of bounds.
See Also: org.xml.sax.Attributes.getType(int) |
| getURI | | public String getURI(int index)(Code) | | Return an attribute's Namespace URI.
Parameters:
index - The attribute's index (zero-based). The Namespace URI, the empty string if none isavailable, or null if the index is out of range.
See Also: org.xml.sax.Attributes.getURI |
| getValue | | public String getValue(int index)(Code) | | Return an attribute's value by index.
Parameters:
index - The attribute's index (zero-based). The attribute's value or null if the index is out of bounds.
See Also: org.xml.sax.Attributes.getValue(int) |
| removeAttribute | | public void removeAttribute(int index)(Code) | | Remove an attribute from the list.
Parameters:
index - The index of the attribute (zero-based).
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setAttribute | | public void setAttribute(int index, String uri, String localName, String qName, String type, String value)(Code) | | Set 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).
Parameters:
uri - The Namespace URI, or the empty string ifnone is available or Namespace processing is notbeing performed.
Parameters:
localName - The local name, or the empty string ifNamespace processing is not being performed.
Parameters:
qName - The qualified name, or the empty stringif qualified names are not available.
Parameters:
type - The attribute type as a string.
Parameters:
value - The attribute value.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setAttributes | | public void setAttributes(Attributes atts)(Code) | | Copy an entire Attributes object.
It may be more efficient to reuse an existing object
rather than constantly allocating new ones.
Parameters:
atts - The attributes to copy. |
| setLocalName | | public void setLocalName(int index, String localName)(Code) | | Set the local name of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
Parameters:
localName - The attribute's local name, or the emptystring for none.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setQName | | public void setQName(int index, String qName)(Code) | | Set the qualified name of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
Parameters:
qName - The attribute's qualified name, or the emptystring for none.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setType | | public void setType(int index, String type)(Code) | | Set the type of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
Parameters:
type - The attribute's type.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setURI | | public void setURI(int index, String uri)(Code) | | Set the Namespace URI of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
Parameters:
uri - The attribute's Namespace URI, or the emptystring for none.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
| setValue | | public void setValue(int index, String value)(Code) | | Set the value of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
Parameters:
value - The attribute's value.
exception:
java.lang.ArrayIndexOutOfBoundsException - When thesupplied index does not point to an attributein the list. |
|
|