This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


org.xml.sax.helpers
class AttributeListImpl

java.lang.Object extended by org.xml.sax.helpers.AttributeListImpl
All Implemented Interfaces:
AttributeList

Most common way to construct:

AttributeListImpl attributes = new AttributeListImpl();

Based on 13 examples


public class AttributeListImpl
extends Object
implements AttributeList

Default implementation for AttributeList.

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.

AttributeList implements the deprecated SAX1 {@link org.xml.sax.AttributeList AttributeList} interface, and has been replaced by the new SAX2 {@link org.xml.sax.helpers.AttributesImpl AttributesImpl} interface.

This class provides a convenience implementation of the SAX {@link org.xml.sax.AttributeList AttributeList} interface. 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.


Constructor Summary

          Create an empty attribute list.

          Construct a persistent copy of an existing attribute list.
 
Method Summary
 void
addAttribute(String name, String type, String value)

          Add an attribute to an attribute list.
 void

          Clear the attribute list.
 int

          Return the number of attributes in the list.
 String
getName(int i)

          Get the name of an attribute (by position).
 String
getType(int i)

          Get the type of an attribute (by position).
 String

          Get the type of an attribute (by name).
 String
getValue(int i)

          Get the value of an attribute (by position).
 String

          Get the value of an attribute (by name).
 void

          Remove an attribute from the list.
 void

          Set the attribute list, discarding previous contents.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttributeListImpl

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


AttributeListImpl

public AttributeListImpl(AttributeList atts)
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
Method Detail

addAttribute

public void addAttribute(String name,
                         String type,
                         String value)
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.
type - The attribute type ("NMTOKEN" for an enumeration).
value - The attribute value (must not be null).

clear

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


getLength

public int getLength()
Return the number of attributes in the list.

Returns:
The number of attributes in the list.

getName

public String getName(int i)
Get the name of an attribute (by position).

Parameters:
i - The position of the attribute in the list.
Returns:
The attribute name as a string, or null if there is no attribute at that position.

getType

public String getType(int i)
Get the type of an attribute (by position).

Parameters:
i - The position of the attribute in the list.
Returns:
The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read), or null if there is no attribute at that position.

getType

public String getType(String name)
Get the type of an attribute (by name).

Parameters:
name - The attribute name.
Returns:
The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read).

getValue

public String getValue(int i)
Get the value of an attribute (by position).

Parameters:
i - The position of the attribute in the list.
Returns:
The attribute value as a string, or null if there is no attribute at that position.

getValue

public String getValue(String name)
Get the value of an attribute (by name).

Parameters:
name - The attribute name.

removeAttribute

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

setAttributeList

public void setAttributeList(AttributeList atts)
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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.