| java.lang.Object
 org.xml.sax.helpers.AttributeListImpl
| AttributeListImpl | | public class AttributeListImpl implements AttributeList(Code) | | Convenience implementation for AttributeList.
This class provides a convenience implementation of the SAX
AttributeList class. This implementation is useful both
for SAX parser writers, who can use it to provide attributes
to the application, and for SAX application writers, who can
use it to create a persistent copy of an element's attribute
specifications:
private AttributeList myatts;
public void startElement (String name, AttributeList atts)
{
// create a persistent copy of the attribute list
// for use outside this method
myatts = new AttributeListImpl(atts);
[...]
}
Please note that SAX parsers are not required to use this
class to provide an implementation of AttributeList; it is
supplied only as an optional convenience. In particular,
parser writers are encouraged to invent more efficient
implementations.
author:
David Megginson (ak117@freenet.carleton.ca)
version:
1.0
See Also: org.xml.sax.AttributeList
See Also: org.xml.sax.DocumentHandler.startElement |
| Method Summary | |
| public void | addAttribute(String name, String type, String value)
Add an attribute to an attribute list. | | public void | clear()
Clear the attribute list.
SAX parser writers can use this method to reset the attribute
list between DocumentHandler.startElement events. | | public int | getLength()
Return the number of attributes in the list. | | public String | getName(int i)
Get the name of an attribute (by position).
Parameters:
i - The position of the attribute in the list. | | public String | getType(int i)
Get the type of an attribute (by position).
Parameters:
i - The position of the attribute in the list. | | public String | getType(String name)
Get the type of an attribute (by name).
Parameters:
name - The attribute name. | | public String | getValue(int i)
Get the value of an attribute (by position).
Parameters:
i - The position of the attribute in the list. | | public String | getValue(String name)
Get the value of an attribute (by name). | | public void | removeAttribute(String name)
Remove an attribute from the list.
SAX application writers can use this method to filter an
attribute out of an AttributeList. | | public void | setAttributeList(AttributeList atts)
Set the attribute list, discarding previous contents. |
| AttributeListImpl | | public AttributeListImpl()(Code) | | Create an empty attribute list.
This constructor is most useful for parser writers, who
will use it to create a single, reusable attribute list that
can be reset with the clear method between elements.
See Also: AttributeListImpl.addAttribute
See Also: AttributeListImpl.clear |
| AttributeListImpl | | public AttributeListImpl(AttributeList atts)(Code) | | Construct a persistent copy of an existing attribute list.
This constructor is most useful for application writers,
who will use it to create a persistent copy of an existing
attribute list.
Parameters:
atts - The attribute list to copy
See Also: org.xml.sax.DocumentHandler.startElement |
| addAttribute | | public void addAttribute(String name, String type, String value)(Code) | | Add an attribute to an attribute list.
This method is provided for SAX parser writers, to allow them
to build up an attribute list incrementally before delivering
it to the application.
Parameters:
name - The attribute name.
Parameters:
type - The attribute type ("NMTOKEN" for an enumeration).
Parameters:
value - The attribute value (must not be null).
See Also: AttributeListImpl.removeAttribute
See Also: org.xml.sax.DocumentHandler.startElement |
| clear | | public void clear()(Code) | | Clear the attribute list.
SAX parser writers can use this method to reset the attribute
list between DocumentHandler.startElement events. Normally,
it will make sense to reuse the same AttributeListImpl object
rather than allocating a new one each time.
See Also: org.xml.sax.DocumentHandler.startElement |
| getName | | public String getName(int i)(Code) | | Get the name of an attribute (by position).
Parameters:
i - The position of the attribute in the list. The attribute name as a string, or null if thereis no attribute at that position.
See Also: org.xml.sax.AttributeList.getName(int) |
| getType | | public String getType(int i)(Code) | | Get the type of an attribute (by position).
Parameters:
i - The position of the attribute in the list. The attribute type as a string ("NMTOKEN" for anenumeration, and "CDATA" if no declaration wasread), or null if there is no attribute atthat position.
See Also: org.xml.sax.AttributeList.getType(int) |
| getValue | | public String getValue(int i)(Code) | | Get the value of an attribute (by position).
Parameters:
i - The position of the attribute in the list. The attribute value as a string, or null ifthere is no attribute at that position.
See Also: org.xml.sax.AttributeList.getValue(int) |
| removeAttribute | | public void removeAttribute(String name)(Code) | | Remove an attribute from the list.
SAX application writers can use this method to filter an
attribute out of an AttributeList. Note that invoking this
method will change the length of the attribute list and
some of the attribute's indices.
If the requested attribute is not in the list, this is
a no-op.
Parameters:
name - The attribute name.
See Also: AttributeListImpl.addAttribute |
| setAttributeList | | public void setAttributeList(AttributeList atts)(Code) | | Set the attribute list, discarding previous contents.
This method allows an application writer to reuse an
attribute list easily.
Parameters:
atts - The attribute list to copy. |
|
|