Added in API level 1
Deprecated in API level 9

AttributeListImpl

open class AttributeListImpl : AttributeList
kotlin.Any
   ↳ org.xml.sax.helpers.AttributeListImpl

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

Summary

Public constructors

Create an empty attribute list.

Construct a persistent copy of an existing attribute list.
Public methods
open Unit
addAttribute(name: String!, type: String!, value: String!)

Add an attribute to an attribute list.
open Unit

Clear the attribute list.
open Int

Return the number of attributes in the list.
open String!

Get the name of an attribute (by position).
open String!

Get the type of an attribute (by position).
open String!
getType(name: String!)

Get the type of an attribute (by name).
open String!

Get the value of an attribute (by position).
open String!
getValue(name: String!)

Get the value of an attribute (by name).
open Unit

Remove an attribute from the list.
open Unit

Set the attribute list, discarding previous contents.

Public constructors

AttributeListImpl

Added in API level 1
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

Added in API level 1
AttributeListImpl(atts: AttributeList!)

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

Public methods

addAttribute

Added in API level 1
open fun addAttribute(
    name: String!, 
    type: String!, 
    value: String!
): Unit

Deprecated: Deprecated in Java.

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

clear

Added in API level 1
open fun clear(): Unit

Deprecated: Deprecated in Java.

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

Added in API level 1
open fun getLength(): Int

Deprecated: Deprecated in Java.

Return the number of attributes in the list.

Return
Int The number of attributes in the list.

getName

Added in API level 1
open fun getName(i: Int): String!

Deprecated: Deprecated in Java.

Get the name of an attribute (by position).

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

getType

Added in API level 1
open fun getType(i: Int): String!

Deprecated: Deprecated in Java.

Get the type of an attribute (by position).

Parameters
i Int: The position of the attribute in the list.
Return
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.

getType

Added in API level 1
open fun getType(name: String!): String!

Deprecated: Deprecated in Java.

Get the type of an attribute (by name).

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

getValue

Added in API level 1
open fun getValue(i: Int): String!

Deprecated: Deprecated in Java.

Get the value of an attribute (by position).

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

getValue

Added in API level 1
open fun getValue(name: String!): String!

Deprecated: Deprecated in Java.

Get the value of an attribute (by name).

Parameters
name String!: The attribute name.
Return
String! the named attribute's value or null, if the attribute does not exist.

removeAttribute

Added in API level 1
open fun removeAttribute(name: String!): Unit

Deprecated: Deprecated in Java.

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

setAttributeList

Added in API level 1
open fun setAttributeList(atts: AttributeList!): Unit

Deprecated: Deprecated in Java.

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.