Home » xml-commons-external-1.4.01-src » org.xml » sax » helpers » [javadoc | source]
org.xml.sax.helpers
public class: AttributesImpl [javadoc | source]
java.lang.Object
   org.xml.sax.helpers.AttributesImpl

All Implemented Interfaces:
    Attributes

Direct Known Subclasses:
    Attributes2Impl

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 Attributes interface, with the addition of manipulators so that the list can be modified or reused.

There are two typical uses of this class:

  1. to take a persistent snapshot of an Attributes object in a startElement event; or
  2. to construct or modify an Attributes object in a SAX2 driver or filter.

This class replaces the now-deprecated SAX1 AttributeListImpl class; in addition to supporting the updated Attributes interface rather than the deprecated AttributeList interface, it also includes a much more efficient implementation using a single array rather than a set of Vectors.

Field Summary
 int length     
 String[] data     
Constructor:
 public AttributesImpl() 
 public AttributesImpl(Attributes atts) 
    Copy an existing Attributes object.

    This constructor is especially useful inside a startElement event.

    Parameters:
    atts - The existing Attributes object.
Method from org.xml.sax.helpers.AttributesImpl Summary:
addAttribute,   clear,   getIndex,   getIndex,   getLength,   getLocalName,   getQName,   getType,   getType,   getType,   getURI,   getValue,   getValue,   getValue,   removeAttribute,   setAttribute,   setAttributes,   setLocalName,   setQName,   setType,   setURI,   setValue
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.xml.sax.helpers.AttributesImpl Detail:
 public  void addAttribute(String uri,
    String localName,
    String qName,
    String type,
    String value) 
    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.

 public  void clear() 
    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.

 public int getIndex(String qName) 
    Look up an attribute's index by qualified (prefixed) name.
 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.

 public int getLength() 
    Return the number of attributes in the list.
 public String getLocalName(int index) 
    Return an attribute's local name.
 public String getQName(int index) 
    Return an attribute's qualified (prefixed) name.
 public String getType(int index) 
    Return an attribute's type by index.
 public String getType(String qName) 
    Look up an attribute's type by qualified (prefixed) name.
 public String getType(String uri,
    String localName) 
    Look up an attribute's type by Namespace-qualified name.
 public String getURI(int index) 
    Return an attribute's Namespace URI.
 public String getValue(int index) 
    Return an attribute's value by index.
 public String getValue(String qName) 
    Look up an attribute's value by qualified (prefixed) name.
 public String getValue(String uri,
    String localName) 
    Look up an attribute's value by Namespace-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.

    For the sake of speed, this method does no checking for name conflicts or well-formedness: such checks are the responsibility of the application.

 public  void setAttributes(Attributes atts) 
    Copy an entire Attributes object.

    It may be more efficient to reuse an existing object rather than constantly allocating new ones.

 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.