Added in API level 1
Deprecated in API level 9

Summary: Ctors | Methods | Inherited Methods

AttributeListImpl

public class AttributeListImpl
extends Object implements AttributeList

java.lang.Object
↳	org.xml.sax.helpers.AttributeListImpl

This class was deprecated in API level 9.
This class implements a deprecated interface, AttributeList; that interface has been replaced by Attributes, which is implemented in the AttributesImpl helper class.

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 AttributeList interface, and has been replaced by the new SAX2 AttributesImpl interface.

This class provides a convenience implementation of the SAX 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.

See also:

Summary

Public constructors
`AttributeListImpl()` Create an empty attribute list.
`AttributeListImpl(AttributeList atts)` Construct a persistent copy of an existing attribute list.

Public methods
`void`	`addAttribute(String name, String type, String value)` Add an attribute to an attribute list.
`void`	`clear()` Clear the attribute list.
`int`	`getLength()` Return the number of attributes in the list.
`String`	`getName(int i)` Get the name of an attribute (by position).
`String`	`getType(String name)` Get the type of an attribute (by name).
`String`	`getType(int i)` Get the type of an attribute (by position).
`String`	`getValue(String name)` Get the value of an attribute (by name).
`String`	`getValue(int i)` Get the value of an attribute (by position).
`void`	`removeAttribute(String name)` Remove an attribute from the list.
`void`	`setAttributeList(AttributeList atts)` Set the attribute list, discarding previous contents.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          org.xml.sax.AttributeList

`abstract int`	`getLength()` Return the number of attributes in this list.
`abstract String`	`getName(int i)` Return the name of an attribute in this list (by position).
`abstract String`	`getType(String name)` Return the type of an attribute in the list (by name).
`abstract String`	`getType(int i)` Return the type of an attribute in the list (by position).
`abstract String`	`getValue(String name)` Return the value of an attribute in the list (by name).
`abstract String`	`getValue(int i)` Return the value of an attribute in the list (by position).

Public constructors

AttributeListImpl

Added in API level 1

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.

See also:

AttributeListImpl

Added in API level 1

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`	`AttributeList`: The attribute list to copy

See also:

DocumentHandler.startElement(String, AttributeList)

Public methods

addAttribute

Added in API level 1

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

See also:

clear

Added in API level 1

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.

See also:

DocumentHandler.startElement(String, AttributeList)

getLength

Added in API level 1

public int getLength ()

Return the number of attributes in the list.

Returns
`int`	The number of attributes in the list.

See also:

AttributeList.getLength()

getName

Added in API level 1

public String getName (int i)

Get the name of an attribute (by position).

Parameters
`i`	`int`: The position of the attribute in the list.

Returns
`String`	The attribute name as a string, or null if there is no attribute at that position.

See also:

AttributeList.getName(int)

getType

Added in API level 1

public String getType (String name)

Get the type of an attribute (by name).

Parameters
`name`	`String`: The attribute name.

Returns
`String`	The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read).

See also:

AttributeList.getType(java.lang.String)

getType

Added in API level 1

public String getType (int i)

Get the type of an attribute (by position).

Parameters
`i`	`int`: The position of the attribute in the list.

Returns
`String`	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.

See also:

AttributeList.getType(int)

getValue

Added in API level 1

public String getValue (String name)

Get the value of an attribute (by name).

Parameters
`name`	`String`: The attribute name.

Returns
`String`	the named attribute's value or null, if the attribute does not exist.

See also:

AttributeList.getValue(java.lang.String)

getValue

Added in API level 1

public String getValue (int i)

Get the value of an attribute (by position).

Parameters
`i`	`int`: The position of the attribute in the list.

Returns
`String`	The attribute value as a string, or null if there is no attribute at that position.

See also:

AttributeList.getValue(int)

removeAttribute

Added in API level 1

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`	`String`: The attribute name.

See also:

addAttribute(String, String, String)

setAttributeList

Added in API level 1

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`	`AttributeList`: The attribute list to copy.